简介
本指南介绍如何使用 GitHub Actions 构建和部署 .NET 项目到 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 创建一个具有 .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"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 应用的新名称。 -
配置 Azure 发布配置文件并创建一个
AZURE_WEBAPP_PUBLISH_PROFILE密钥。使用发布配置文件生成您的 Azure 部署凭据。有关更多信息，请参阅 Azure 文档中的“生成部署凭据”。
在您的 GitHub 存储库中，创建一个名为
AZURE_WEBAPP_PUBLISH_PROFILE的密钥，其中包含发布配置文件的内容。有关创建密钥的更多信息，请参阅“在 GitHub Actions 中使用密钥”。 -
可以选择配置部署环境。环境用于描述一般的部署目标，例如
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 键。
# 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 }}
# 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 }}
其他资源
以下资源可能也有用
- 有关原始入门工作流，请参阅 GitHub Actions
starter-workflows存储库中的azure-webapps-dotnet-core.yml。 - 用于部署 Web 应用的操作是官方的 Azure
Azure/webapps-deploy操作。 - 有关部署到 Azure 的 GitHub Action 工作流的更多示例，请参阅 actions-workflow-samples 存储库。