将.NET 部署到 Azure 应用服务

您可以将 .NET 项目部署到 Azure 应用服务，作为持续部署 (CD) 工作流的一部分。

本文内容

简介

本指南说明如何使用 GitHub Actions 将 .NET 项目构建并部署到Azure 应用服务。

注意

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

先决条件

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

  1. 创建 Azure 应用服务计划。

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

    Bash
    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 文档。

  2. 创建 Web 应用。

    例如，您可以使用 Azure CLI 创建具有 .NET 运行时的 Azure 应用服务 Web 应用

    Bash
    az webapp create \
    --name MY_WEBAPP_NAME \
    --plan MY_APP_SERVICE_PLAN \
    --resource-group MY_RESOURCE_GROUP \
    --runtime "DOTNET|5.0"

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

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

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

    在您的 GitHub 存储库中，创建一个名为AZURE_WEBAPP_PUBLISH_PROFILE的密钥，其中包含发布配置文件的内容。有关创建密钥的更多信息，请参阅“在 GitHub Actions 中使用密钥”。

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

创建工作流

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

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

确保您在工作流env密钥中将AZURE_WEBAPP_NAME设置为您创建的 Web 应用的名称。如果项目的路径不是存储库根目录，请更改AZURE_WEBAPP_PACKAGE_PATH。如果您使用的是 .NET 5 以外的版本，请更改DOTNET_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 ASP.Net Core app to an 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
  DOTNET_VERSION: '5'                 # set this to the .NET Core version to use

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up .NET Core
        uses: actions/setup-dotnet@v3
        with:
          dotnet-version: ${{ env.DOTNET_VERSION }}

      - name: Set up dependency caching for faster builds
        uses: actions/cache@v3
        with:
          path: ~/.nuget/packages
          key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
          restore-keys: |
            ${{ runner.os }}-nuget-

      - name: Build with dotnet
        run: dotnet build --configuration Release

      - name: dotnet publish
        run: dotnet publish -c Release -o ${{env.DOTNET_ROOT}}/myapp

      - name: Upload artifact for deployment job
        uses: actions/upload-artifact@v4
        with:
          name: .net-app
          path: ${{env.DOTNET_ROOT}}/myapp

  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: .net-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: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}

其他资源

以下资源也可能有用