在本快速入门中,你将了解如何创建 GitHub 工作流,以便从源代码发布 .NET 应用。 自动将 .NET 应用从 GitHub 发布到目标称为持续部署(CD)。 在本快速入门中,有许多可能的发布目的地,而您将发布到 Azure。
先决条件
添加发布资料
若要将应用发布到 Azure,请打开应用程序的应用服务实例的 Azure 门户。 在资源 概述 中,选择 获取发布配置文件,并将 .PublishSetting 文件保存到本地。
警告
发布配置文件包含敏感信息,例如访问 Azure 应用服务资源所需的凭据。 此信息应始终受到非常仔细的处理。
在 GitHub 存储库中,导航到 “设置” 并从左侧导航菜单中选择“ 机密 ”。 选择 “新建存储库机密”以添加新机密。
输入 AZURE_PUBLISH_PROFILE 为 “名称”,并将发布配置文件中的 XML 内容粘贴到 “值 ”文本区域中。 选择“添加机密”。 有关详细信息,请参阅 加密机密。
创建工作流文件
在 GitHub 存储库中,将新的 YAML 文件添加到 .github/workflows 目录。 选择一个有意义的文件名,以明确说明工作流的目的。 有关详细信息,请参阅 工作流文件。
重要
GitHub 要求将工作流组合文件放置在 .github/workflows 目录中。
工作流文件通常通过 jobs.<job_id>/steps[*] 定义一个或多个 GitHub Action 的组合。 有关详细信息,请参阅 GitHub Actions 的工作流语法。
创建名为 publish-app.yml的新文件,将以下 YML 内容复制并粘贴到其中:
name: publish
on:
push:
branches: [ production ]
env:
AZURE_WEBAPP_NAME: DotNetWeb
AZURE_WEBAPP_PACKAGE_PATH: '.' # Set this to the path to your web app project, defaults to the repository root:
DOTNET_VERSION: '6.0.401' # The .NET SDK version to use
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup .NET Core
uses: actions/setup-dotnet@v3
with:
dotnet-version: ${{ env.DOTNET_VERSION }}
- name: Install dependencies
run: dotnet restore
- name: Build
run: |
cd DotNet.WebApp
dotnet build --configuration Release --no-restore
dotnet publish -c Release -o ../dotnet-webapp -r linux-x64 --self-contained true /p:UseAppHost=true
- name: Test
run: |
cd DotNet.WebApp.Tests
dotnet test --no-restore --verbosity normal
- uses: azure/webapps-deploy@v2
name: Deploy
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_PUBLISH_PROFILE }}
package: '${{ env.AZURE_WEBAPP_PACKAGE_PATH }}/dotnet-webapp'
在前面的工作流组合中:
定义
name: publish为名称,则“发布”将显示在工作流状态徽章中。name: publish节点
on表示触发工作流的事件:on: push: branches: [ production ]- 在
production分支上push发生时触发。
- 在
节点
env定义命名环境变量(env var)。env: AZURE_WEBAPP_NAME: DotNetWeb AZURE_WEBAPP_PACKAGE_PATH: '.' # Set this to the path to your web app project, defaults to the repository root: DOTNET_VERSION: '6.0.401' # The .NET SDK version to use- 为环境变量
AZURE_WEBAPP_NAME赋值DotNetWeb。 - 为环境变量
AZURE_WEBAPP_PACKAGE_PATH赋值'.'。 - 为环境变量
DOTNET_VERSION赋值'6.0.401'。 稍后将引用环境变量以指定dotnet-versionactions/setup-dotnet@v3GitHub Action。
- 为环境变量
节点
jobs将生成工作流要执行的步骤。jobs: publish: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Setup .NET Core uses: actions/setup-dotnet@v3 with: dotnet-version: ${{ env.DOTNET_VERSION }} - name: Install dependencies run: dotnet restore - name: Build run: | cd DotNet.WebApp dotnet build --configuration Release --no-restore dotnet publish -c Release -o ../dotnet-webapp -r linux-x64 --self-contained true /p:UseAppHost=true - name: Test run: | cd DotNet.WebApp.Tests dotnet test --no-restore --verbosity normal - uses: azure/webapps-deploy@v2 name: Deploy with: app-name: ${{ env.AZURE_WEBAPP_NAME }} publish-profile: ${{ secrets.AZURE_PUBLISH_PROFILE }} package: '${{ env.AZURE_WEBAPP_PACKAGE_PATH }}/dotnet-webapp'- 有一个名为
publish的作业将在最新版本的 Ubuntu 上运行。 -
actions/setup-dotnet@v3GitHub Action 用于根据环境变量中指定的版本来设置 .NET SDK。 - 调用
dotnet restore命令。 - 调用
dotnet build命令。 - 调用
dotnet publish命令。 - 调用
dotnet test命令。 -
azure/webapps-deploy@v2GitHub Action 使用给定的publish-profile和package来部署该应用程序。-
publish-profile是从AZURE_PUBLISH_PROFILE仓库密钥中分配的。
-
- 有一个名为
创建工作流状态徽章
在 GitHub 存储库中,在存储库目录的根目录通常会有一个名为 README.md 的文件。 同样,最好报告各种工作流的最新状态。 所有工作流都可以生成状态徽章,该徽章在 README.md 文件中具有视觉吸引力。 若要添加工作流状态徽章,请执行以下操作:
从 GitHub 存储库中选择 操作 导航选项。
所有存储库工作流都显示在左侧,选择所需的工作流和省略号 (...) 按钮。
- 省略号 (...) 按钮将展开所选工作流的菜单选项。
选择创建状态徽章菜单选项。
选择 “复制状态徽章 Markdown ”按钮。
将 Markdown 粘贴到 README.md 文件中,保存文件,提交并推送更改。
有关详细信息,请参阅 添加工作流状态徽章。
发布工作流状态徽章示例
| 通过(如考试或测试成功通过) | 失败 | 无状态 |
|---|---|---|
|
|
|
|