将 PHP 部署到 Azure 应用服务

简介

本指南介绍如何使用 GitHub Actions 构建和部署 PHP 项目到 Azure 应用服务。

注意

如果您的 GitHub Actions 工作流需要访问支持 OpenID Connect (OIDC) 的云提供商中的资源，您可以将工作流配置为直接对云提供商进行身份验证。这将允许您停止将这些凭据存储为长期存在的密钥，并提供其他安全优势。有关更多信息，请参阅“关于使用 OpenID Connect 进行安全加固”和“在 Azure 中配置 OpenID Connect”。

先决条件

在创建 GitHub Actions 工作流之前，您需要先完成以下设置步骤

创建一个 Azure 应用服务计划。

例如，您可以使用 Azure CLI 创建一个新的应用服务计划
Bash
```
az appservice plan create \
   --resource-group MY_RESOURCE_GROUP \
   --name MY_APP_SERVICE_PLAN \
   --is-linux
```
```
az appservice plan create \
   --resource-group MY_RESOURCE_GROUP \
   --name MY_APP_SERVICE_PLAN \
   --is-linux
```
在上面的命令中，将 MY_RESOURCE_GROUP 替换为您预先存在的 Azure 资源组，并将 MY_APP_SERVICE_PLAN 替换为应用服务计划的新名称。

有关使用 Azure CLI 的更多信息，请参阅 Azure 文档。
- 有关身份验证，请参阅“使用 Azure CLI 登录”。
- 如果您需要创建新的资源组，请参阅“az group”。

创建 Web 应用。

例如，您可以使用 Azure CLI 创建一个使用 PHP 运行时的 Azure 应用服务 Web 应用

Bash

az webapp create \
    --name MY_WEBAPP_NAME \
    --plan MY_APP_SERVICE_PLAN \
    --resource-group MY_RESOURCE_GROUP \
    --runtime "php|7.4"

az webapp create \
    --name MY_WEBAPP_NAME \
    --plan MY_APP_SERVICE_PLAN \
    --resource-group MY_RESOURCE_GROUP \
    --runtime "php|7.4"

在上面的命令中，将参数替换为您自己的值，其中MY_WEBAPP_NAME 是 Web 应用的新名称。

配置 Azure 发布配置文件并创建一个AZURE_WEBAPP_PUBLISH_PROFILE 密钥。

使用发布配置文件生成您的 Azure 部署凭据。有关更多信息，请参阅 Azure 文档中的“生成部署凭据”。

在您的 GitHub 存储库中，创建一个名为AZURE_WEBAPP_PUBLISH_PROFILE 的密钥，其中包含发布配置文件的内容。有关创建密钥的更多信息，请参阅“在 GitHub Actions 中使用密钥”。
可选，配置部署环境。环境用于描述一般的部署目标，例如production、staging 或development。当 GitHub Actions 工作流部署到环境时，该环境将显示在存储库的主页上。您可以使用环境来要求批准作业才能继续，限制哪些分支可以触发工作流，使用自定义部署保护规则来控制部署，或限制对密钥的访问。有关创建环境的更多信息，请参阅“管理部署环境”。

创建工作流

完成先决条件后，您可以继续创建工作流。

以下示例工作流演示了如何在将代码推送到main 分支时构建并部署 PHP 项目到 Azure 应用服务。

确保您在工作流的env 密钥中设置了AZURE_WEBAPP_NAME 为您创建的 Web 应用的名称。如果项目的路径不是存储库根目录，请将AZURE_WEBAPP_PACKAGE_PATH 更改为项目的路径。如果您使用的是除8.x以外的 PHP 版本，请将PHP_VERSION 更改为您使用的版本。

如果您配置了部署环境，请将environment 的值更改为您的环境名称。如果您没有配置环境，或者您的工作流位于私有存储库中并且您不使用 GitHub Enterprise Cloud，请删除environment 密钥。

YAML

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# GitHub recommends pinning actions to a commit SHA.
# To get a newer version, you will need to update the SHA.
# You can also reference a tag or branch, but the action may change without warning.

name: Build and deploy PHP app to Azure Web App

env:
  AZURE_WEBAPP_NAME: MY_WEBAPP_NAME   # set this to your application's name
  AZURE_WEBAPP_PACKAGE_PATH: '.'      # set this to the path to your web app project, defaults to the repository root
  PHP_VERSION: '8.x'                  # set this to the PHP version to use

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Setup PHP
        uses: shivammathur/setup-php@1f2e3d4c5b6a7f8e9d0c1b2a3e4f5d6c7b8a9e0f
        with:
          php-version: ${{ env.PHP_VERSION }}

      - name: Check if composer.json exists
        id: check_files
        uses: andstor/file-existence-action@2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b
        with:
          files: 'composer.json'

      - name: Get Composer Cache Directory
        id: composer-cache
        if: steps.check_files.outputs.files_exists == 'true'
        run: |
          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

      - name: Set up dependency caching for faster installs
        uses: actions/cache@v3
        if: steps.check_files.outputs.files_exists == 'true'
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-composer-

      - name: Run composer install if composer.json exists
        if: steps.check_files.outputs.files_exists == 'true'
        run: composer validate --no-check-publish && composer install --prefer-dist --no-progress

      - name: Upload artifact for deployment job
        uses: actions/upload-artifact@v4
        with:
          name: php-app
          path: .

  deploy:
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: 'production'
      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}

    steps:
      - name: Download artifact from build job
        uses: actions/download-artifact@v4
        with:
          name: php-app

      - name: 'Deploy to Azure Web App'
        id: deploy-to-webapp
        uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c
        with:
          app-name: ${{ env.AZURE_WEBAPP_NAME }}
          publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
          package: .

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# GitHub recommends pinning actions to a commit SHA.
# To get a newer version, you will need to update the SHA.
# You can also reference a tag or branch, but the action may change without warning.

name: Build and deploy PHP app to Azure Web App

env:
  AZURE_WEBAPP_NAME: MY_WEBAPP_NAME   # set this to your application's name
  AZURE_WEBAPP_PACKAGE_PATH: '.'      # set this to the path to your web app project, defaults to the repository root
  PHP_VERSION: '8.x'                  # set this to the PHP version to use

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Setup PHP
        uses: shivammathur/setup-php@1f2e3d4c5b6a7f8e9d0c1b2a3e4f5d6c7b8a9e0f
        with:
          php-version: ${{ env.PHP_VERSION }}

      - name: Check if composer.json exists
        id: check_files
        uses: andstor/file-existence-action@2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b
        with:
          files: 'composer.json'

      - name: Get Composer Cache Directory
        id: composer-cache
        if: steps.check_files.outputs.files_exists == 'true'
        run: |
          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

      - name: Set up dependency caching for faster installs
        uses: actions/cache@v3
        if: steps.check_files.outputs.files_exists == 'true'
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-composer-

      - name: Run composer install if composer.json exists
        if: steps.check_files.outputs.files_exists == 'true'
        run: composer validate --no-check-publish && composer install --prefer-dist --no-progress

      - name: Upload artifact for deployment job
        uses: actions/upload-artifact@v4
        with:
          name: php-app
          path: .

  deploy:
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: 'production'
      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}

    steps:
      - name: Download artifact from build job
        uses: actions/download-artifact@v4
        with:
          name: php-app

      - name: 'Deploy to Azure Web App'
        id: deploy-to-webapp
        uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c
        with:
          app-name: ${{ env.AZURE_WEBAPP_NAME }}
          publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
          package: .

其他资源

以下资源可能也有用

有关原始工作流模板，请参阅 GitHub Actions starter-workflows 存储库中的azure-webapps-php.yml。
用于部署 Web 应用的操作是官方的 Azure Azure/webapps-deploy 操作。
有关部署到 Azure 的 GitHub Action 工作流的更多示例，请参阅actions-workflow-samples存储库。

本文内容

简介

先决条件

创建工作流

其他资源