快速入门:创建 GitHub 工作流以发布应用
在本快速入门中,你将了解如何创建 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 ]
- 当
push
在production
分支上发生时触发。
- 当
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'
。 稍后将引用环境变量以指定actions/setup-dotnet@v3
GitHub Action 的dotnet-version
。
- 将环境变量
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@v3
GitHub Action 用于使用DOTNET_VERSION
环境变量中的指定版本设置 .NET SDK。- 调用
dotnet restore
命令。 - 调用
dotnet build
命令。 - 调用
dotnet publish
命令。 - 调用
dotnet test
命令。 azure/webapps-deploy@v2
GitHub Action 使用给定的publish-profile
和package
部署应用。- 从
AZURE_PUBLISH_PROFILE
存储库机密中分配publish-profile
。
- 从
- 有一个名为
创建工作流状态徽章
GitHub 存储库有一个 README.md 文件,位于存储库目录的根目录下。 同样,最好报告各种工作流的最新状态。 所有工作流都可以生成一个状态徽章,它在 README.md 文件中具有视觉吸引力。 若要添加工作流状态徽章,请执行以下操作:
从 GitHub 存储库中选择“Actions”导航选项。
所有存储库工作流都显示在左侧,选择所需的工作流和省略号 (...) 按钮。
- 省略号 (...) 按钮展开所选工作流的菜单选项。
选择“创建状态徽章”菜单选项。
选择“复制状态徽章 Markdown”按钮。
将 Markdown 粘贴到 README.md 文件中,保存文件,提交并推送更改。
有关详细信息,请参阅添加工作流状态徽章。
发布工作流状态徽章示例
通过 | 失败 | 无状态 |
---|---|---|