コンテンツへスキップ

.NET GitHub Actions ワークフローテンプレート

最終更新

これは .NET ソリューション用の動作する .github/workflows/ci.yml です。SDK をインストールし、NuGet パッケージのフォルダーをキャッシュし、一度だけリストアして、Release モードでビルドし、再ビルドせずにテストを実行します。

ワークフロー

name: CI

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read

concurrency:
  group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
  DOTNET_NOLOGO: "true"
  DOTNET_CLI_TELEMETRY_OPTOUT: "true"
  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: "true"

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-dotnet@v4
        with:
          dotnet-version: 9.0.x

      - uses: actions/cache@v4
        with:
          path: ~/.nuget/packages
          key: nuget-${{ runner.os }}-${{ hashFiles('**/*.csproj', '**/Directory.Packages.props', '**/packages.lock.json') }}
          restore-keys: |
            nuget-${{ runner.os }}-

      - run: dotnet restore
      - run: dotnet build --no-restore --configuration Release
      - run: dotnet test --no-build --configuration Release --verbosity normal

分かりにくい部分の役割

  • dotnet-version: 9.0.x は 9.0 系の最新パッチを使用します。プロジェクトの対象バージョンに合わせて指定するか、リポジトリで固定した SDK に従うには global-json-file: global.json を使用してください。
  • NuGet キャッシュのステップは ~/.nuget/packages を保存します。setup-dotnet には cache: true オプションがありますが、packages.lock.json ロックファイルが必要なため、明示的な actions/cache ステップの方が幅広く使えます。パッケージを追加すると新しいキャッシュが作られるよう、プロジェクトファイルをキーにしています。
  • restore、続いて --no-restore、さらに --no-build。各ステップは一つの役割だけを担います。これらのフラグがないと、build と test がそれぞれ前のステップを繰り返し、時間を無駄にします。
  • 環境変数。3 つの DOTNET_ 設定により、ログを煩雑にする初回起動時のバナー、テレメトリー、初回実行時の処理を省きます。
  • Release 構成。テストは出荷するものと同じ条件で実行されます。テストがデバッグシンボルに依存する場合にのみ Debug を使用してください。
  • Linux ランナー。.NET はクロスプラットフォームで動作し、Linux の実行時間が最も安価です。

バリエーション

SQL Server サービスコンテナー

    services:
      mssql:
        image: mcr.microsoft.com/mssql/server:2022-latest
        env:
          ACCEPT_EULA: "Y"
          MSSQL_SA_PASSWORD: "Ci_Passw0rd!"
        ports:
          - 1433:1433
        options: >-
          --health-cmd "/opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P Ci_Passw0rd! -Q 'SELECT 1'"
          --health-interval 10s
          --health-retries 10

その後、環境変数で接続文字列を設定します。SQL Server のイメージは Postgres より起動に多くのメモリと時間を必要とします。Django テンプレートのような Postgres サービスも、同じ構造で利用できます。

複数のターゲットフレームワーク

dotnet-version: [8.0.x, 9.0.x] を指定したマトリックスを追加します。マトリックスビルドを参照してください。

コードカバレッジ

dotnet test に --collect:"XPlat Code Coverage" を追加し、結果を アーティファクトとしてアップロードします。

公開とデプロイ

main ブランチで needs: build を指定した 2 つ目のジョブを追加し、dotnet publish -c Release -o out を実行します。デプロイには OIDC を使用します。

Windows や macOS

デスクトップ向けやクロスプラットフォームのライブラリでは、マトリックスに追加してください。Windows は分単位の料金が高いため、必要な場合にのみ使用してください。

より高速なマシンで実行する

1 行を変更します:

    runs-on: [self-hosted, Linux, compiler-ci]

このジョブは compiler.dev の新品の 8 vCPU マシンで実行され、元のランナーへの自動フォールバックも備えています。compiler.dev が行った React、ASP.NET Core、SQL Server のベンチマークでは、3m34s から 1m41s に短縮されました。詳しくはベンチマークを、.NET を GitHub Actions で高速化する方法はGitHub Actions で .NET を高速化するを、料金は料金をご覧ください。

よくある質問

setup-dotnet のキャッシュオプションを使わない理由は?

これは NuGet ロックファイルを使用している場合にのみ機能します。使用している場合は、cache: true の方が簡単です。

リストアは別に実行する必要がありますか?

厳密には不要ですが、リストアを分けるとキャッシュの効果がログで確認でき、その後 --no-restore を使用できます。

テストを並列で実行するには?

xUnit と NUnit はプロジェクト内で並列化されます。さらに高速化するには、プロジェクト単位でテストのシャーディングを使用してください。

SQL Server のパスワード規則はどうなりますか?

sa のパスワードは複雑さの規則を満たす必要があり、満たさないとコンテナーが終了します。例のパスワードは規則を満たしています。