将 Node.js 部署到 Azure App Service

简介

本指南说明如何使用 GitHub Actions 构建、测试并部署 Node.js 项目到 Azure App Service。

基本要求

在创建 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 创建具有 Node.js 运行时的 Azure App Service Web 应用：

   Shell

   az webapp create \
       --name MY_WEBAPP_NAME \
       --plan MY_APP_SERVICE_PLAN \
       --resource-group MY_RESOURCE_GROUP \
       --runtime "NODE|14-lts"

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

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

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

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

4. Optionally, configure a deployment environment. 环境用于描述一般的部署目� �，如生产、暂存或开发。 当 GitHub Actions 工作流程部署到某个环境时，该环境将显示在存储库的主页上。 您可以使用环境来要求批准才能继续作业，限制哪些分支可以触发工作流程，或限制对机密的访问。 有关创建环境的更多信息，请参阅“使用环境进行部署”。

创建工作流程

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

以下示例工作流演程示在推送到 main 分支时，如何构建、测试 Node.js 项目并将其部署到 Azure App Service。

确保在工作流程 env 中将 AZURE_WEBAPP_NAME 密钥设置为您创建的 web 应用程序名称。 如果项目的路径不是存储库� �目录，请将 AZURE_WEBAPP_PACKAGE_PATH 更改为您的项目路径。 如果使用的 Node.js 版本不是 10.x，请将 NODE_VERSION 更改为您使用的版本。

如果配置了部署环境，请将 environment 的值更改为环境的名称。 如果未配置环境，则� 除 environment 键。

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

on:
  push:
    branches:
      - main

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: ${{ env.NODE_VERSION }}
        cache: 'npm'

    - name: npm install, build, and test
      run: |
        npm install
        npm run build --if-present
        npm run test --if-present
    - name: Upload artifact for deployment job
      uses: actions/upload-artifact@v2
      with:
        name: node-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@v2
      with:
        name: node-app

    - name: 'Deploy to Azure WebApp'
      id: deploy-to-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 }}

其他资源

以下资源也可能有用：

• 有关原始入门工作流程，请参阅 GitHub Actions starter-workflows 仓库中的 azure-webapps-node.yml。
• 用于部署 Web 应用的操作是正式的 Azure Azure/webapps-deploy 操作。
• 有关部署到 Azure 的 GitHub 操作工作流程的更多示例，请参阅 actions-workflow-samples 存储库。
• Azure web 应用文档中的“在 Azure 中创建 Node.js Web 应用”快速入门介绍了 Visual Studio Code 与 Azure 应用服务扩展一起使用。