部署到 Azure App Service

简介

本指南说明如何使用 GitHub Actions 生成、测试并部署应用程序到 Azure App Service。

Azure App Service 可以用几种语言运行 web 应用程序，但本指南演示的是部署现有的 Node.js 项目。

基本要求

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

1. 创建 Azure App Service 计划。

   例如，可以使用 Azure CLI 创建新的应用服务计划：

   Shell

   az appservice plan create \
       --resource-group MY_RESOURCE_GROUP \
       --name MY_APP_SERVICE_PLAN \
       --is-linux

   在上述命令中，将 MY_ResourcesURCE_GROUP 替换为您原有的 Azure 资源组，MY_APP_SERVICE_PLAN 替换为应用服务计划的新名称。

   请查看 Azure 文档以了解更多有关使用 Azure CLI 的信息：

   • 有关身份验证，请参阅“使用 Azure CLI 登录”。
   • 如果需要创建新的资源组，请参阅“az 组”。

2. 创建 Web 应用。

   例如，可以使用 Azure CLI 创建具有节点运行时的 Azure App Service Web 应用：

   Shell

   az webapp create \
       --name MY_WEBAPP_NAME \
       --plan MY_APP_SERVICE_PLAN \
       --resource-group MY_RESOURCE_GROUP \
       --runtime "node|10.14"

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

3. 配置 Azure 发布配置文件并创建 AZURE_WEBAPP_PUBLISH_PROFILE 机密。

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

   在 GitHub 仓库中，创建一个名为 AZURE_WEBAPP_PUBLISH_PROFILE 的机密，其中包含发布配置文件的内容。 有关创建机密的更多信息，请参阅“加密密码”。

4. For Linux apps, add an app setting called WEBSITE_WEBDEPLOY_USE_SCM and set it to true in your app. For more information, see "Configure apps in the portal" in the Azure documentation.

5. Optionally, configure a deployment environment. Environments are used to describe a general deployment target like production, staging, or development. When a GitHub Actions workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. For more information about creating environments, see "Using environments for deployment."

创建工作流程

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

The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when a release is created.

确保在工作流程 env 中将 AZURE_WEBAPP_NAME 密钥设置为您创建的 web 应用程序名称。 You can also change AZURE_WEBAPP_PACKAGE_PATH if the path to your project is not the repository root and NODE_VERSION if you want to use a node version other than 10.x.

If you configured a deployment environment, change the value of environment to be the name of your environment. If you did not configure an environment, delete the environment key.

# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档管理。

on:
  release:
    types: [created]

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
  NODE_VERSION: '10.x'                # set this to the node version to use

jobs:
  build-and-deploy:
    name: Build and Deploy
    runs-on: ubuntu-latest
    environment: production

    steps:
      - uses: actions/checkout@v2

      - name: Use Node.js ${{ env.NODE_VERSION }}
        uses: actions/setup-node@v2
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: npm install, build, and test
        run: |
          # Build and test the project, then
          # deploy to Azure Web App.
          npm install
          npm run build --if-present
          npm run test --if-present

      - name: 'Deploy to Azure WebApp'
        uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
        with:
          app-name: ${{ env.AZURE_WEBAPP_NAME }}
          publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
          package: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}

其他资源

以下资源也可能有用：

• For the original starter workflow, see azure.yml in the GitHub Actions starter-workflows repository.
• 用于部署 Web 应用的操作是正式的 Azure Azure/webapps-deploy 操作。
• For more examples of GitHub Action workflows that deploy to Azure, see the actions-workflow-samples repository.
• Azure web 应用文档中的“在 Azure 中创建 Node.js web 应用”快速入门说明如何通过 Azure App Service 扩展使用 VS Code。