将 Node.js 部署到 Azure 应用服务

简介

本指南介绍如何使用 GitHub Actions 来构建、测试和将 Node.js 项目部署到 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 创建一个使用 Node.js 运行时的 Azure 应用服务 Web 应用

Bash

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

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 应用的新名称。

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

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

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

创建工作流

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

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

确保您在工作流env密钥中设置AZURE_WEBAPP_NAME为已创建的 Web 应用的名称。如果项目的路径不是存储库根目录，请将AZURE_WEBAPP_PACKAGE_PATH更改为您的项目路径。如果您使用的是除10.x以外的 Node.js 版本，请将NODE_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.

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@v4

    - name: Set up Node.js
      uses: actions/setup-node@v4
      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@v4
      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@v4
      with:
        name: node-app

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

# 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.

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@v4

    - name: Set up Node.js
      uses: actions/setup-node@v4
      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@v4
      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@v4
      with:
        name: node-app

    - name: 'Deploy to Azure WebApp'
      id: deploy-to-webapp
      uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c
      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 Action 工作流的更多示例，请参阅actions-workflow-samples存储库。
Azure Web 应用文档中的“在 Azure 中创建 Node.js Web 应用”快速入门演示了如何使用 Visual Studio Code 和Azure 应用服务扩展。

本文内容

简介

前提条件

创建工作流

其他资源