构建和测试 .NET

注：GitHub Enterprise Server 2.22 上的 GitHub Actions 支持是有限的公测版。测试已结束。 GitHub Actions 现在一般可用于 GitHub Enterprise Server 3.0 或更新版本。更多信息请参阅 GitHub Enterprise Server 3.0 发行说明。

有关升级到 GitHub Enterprise Server 3.0 或更新版本的更多信息，请参阅“升级 GitHub Enterprise Server”。
有关在升级后配置 GitHub Actions 的更多信息，请参阅 GitHub Enterprise Server 3.0 的文档。

注： GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。您可以在 GitHub 公共路线图上查看有关未来支持计划的更多信息。

简介

本指南介绍如何构建、测试和发布 .NET 包。

GitHub 托管的运行器有工具缓存预安装的软件，包括 .NET Core SDK。有关最新版软件以及 .NET Core SDK 预安装版本的完整列表，请参阅 GitHub 自托管运行器上安装的软件。

基本要求

您应该已经熟悉 YAML 语法及其如何与 GitHub Actions 结合使用。更多信息请参阅“GitHub Actions 的工作流程语法”。

建议您对 .NET Core SDK 有个基本的了解。更多信息请参阅“开始使用 .NET”。

从 .NET 工作流程模板开始

GitHub 提供了一个 .NET 工作流程模板，该模板应适合大多数 .NET 项目，本指南包括演示如何自定义此模板的示例。更多信息请参阅 .NET 工作流程模板。

要快速开始，请将模板添加到仓库的 .github/workflows 目录中。

name: dotnet package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        dotnet-version: ['3.0', '3.1.x', '5.0.x' ]

    steps:
      - uses: actions/checkout@v2
      - name: Setup .NET Core SDK ${{ matrix.dotnet-version }}
        uses: actions/setup-dotnet@v1.7.2
        with:
          dotnet-version: ${{ matrix.dotnet-version }}
      - name: Install dependencies
        run: dotnet restore
      - name: Build
        run: dotnet build --configuration Release --no-restore
      - name: Test
        run: dotnet test --no-restore --verbosity normal

指定 .NET 版本

要在 GitHub 托管的运行器上使用预安装的 .NET Core SDK 版本，请使用 setup-dotnet 操作。此操作从每个运行器上的工具缓存中查找特定版本的 .NET，并将必要的二进制文件添加到 PATH。这些更改将持续用于作业的其余部分。

setup-dotnet 操作是 .NET 与 GitHub Actions 结合使用时的推荐方式，因为它能确保不同运行器和不同版本的 .NET 行为一致。如果使用自托管运行器，则必须安装 .NET 并将其添加到 PATH。更多信息请参阅 setup-dotnet 操作。

使用多个 .NET 版本

name: dotnet package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        dotnet: [ '3.0', '3.1.x', '5.0.x' ]

    steps:
      - uses: actions/checkout@v2
      - name: Setup dotnet ${{ matrix.dotnet-version }}
        uses: actions/setup-dotnet@v1
        with:
          dotnet-version: ${{ matrix.dotnet-version }}
      # You can test your matrix by printing the current dotnet version
      - name: Display dotnet version
        run: dotnet --version

使用特定的 .NET 版本

您可以将作业配置为使用 .NET 的特定版本，例如 3.1.3 3.1.3。或者，您也可以使用语义版本语法来获得最新的次要版本。此示例使用 .NET 3 最新的次要版本。

    - name: Setup .NET 3.x
      uses: actions/setup-dotnet@v1
      with:
        # Semantic version range syntax or exact version of a dotnet version
        dotnet-version: '3.x'

安装依赖项

GitHub 托管的运行器安装了 NuGet 软件包管理器。在构建和测试代码之前，您可以使用 dotnet CLI 从 NuGet 软件包注册表安装依赖项。例如，下面的 YAML 安装 Newtonsoft 软件包。

steps:
- uses: actions/checkout@v2
- name: Setup dotnet
  uses: actions/setup-dotnet@v1
  with:
    dotnet-version: '3.1.x'
- name: Install dependencies
  run: dotnet add package Newtonsoft.Json --version 12.0.1

构建和测试代码

您可以使用与本地相同的命令来构建和测试代码。此示例演示如何在作业中使用 dotnet build 和 dotnet test：

steps:
- uses: actions/checkout@v2
- name: Setup dotnet
  uses: actions/setup-dotnet@v1
  with:
    dotnet-version: '3.1.x'
- name: Install dependencies
  run: dotnet restore
- name: Build
  run: dotnet build
- name: Test with the dotnet CLI
  run: dotnet test

将工作流数据打包为构件

工作流程完成后，您可以上传产生的项目进行分析。例如，您可能需要保存日志文件、核心转储、测试结果或屏幕截图。下面的示例演示如何使用 upload-artifact 操作来上传测试结果。

更多信息请参阅“使用构件持久化工作流程”。

name: dotnet package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        dotnet-version: [ '3.0', '3.1.x', '5.0.x' ]

      steps:
        - uses: actions/checkout@v2
        - name: Setup dotnet
          uses: actions/setup-dotnet@v1
          with:
            dotnet-version: ${{ matrix.dotnet-version }}
        - name: Install dependencies
          run: dotnet restore
        - name: Test with dotnet
          run: dotnet test --logger trx --results-directory "TestResults-${{ matrix.dotnet-version }}"
        - name: Upload dotnet test results
          uses: actions/upload-artifact@v2
          with:
            name: dotnet-results-${{ matrix.dotnet-version }}
            path: TestResults-${{ matrix.dotnet-version }}
          # Use always() to always run this step to publish test results when there are test failures
          if: ${{ always() }}

发布到包注册表

您可以配置工作流程在 CI 测试通过后将 Dotnet 包发布到包注册表。您可以使用仓库机密来存储发布二进制文件所需的任何令牌或凭据。下面的示例使用 dotnet core cli创建并发布软件包到 GitHub Packages。

name: Upload dotnet package

on:
  release:
    types: [created]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-dotnet@v1
        with:
          dotnet-version: '3.1.x' # SDK Version to use.
          source-url: https://nuget.pkg.github.com/<owner>/index.json
        env:
          NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
      - run: dotnet build --configuration Release <my project>
      - name: Create the package
        run: dotnet pack --configuration Release <my project>
      - name: Publish the package to GPR
        run: dotnet nuget push <my project>/bin/Release/*.nupkg

按产品浏览

本文内容