Go GitHub Actions ワークフローテンプレート
最終更新
これは Go モジュール用の、そのまま動作する .github/workflows/ci.yml です。go.mod から Go のバージョンを読み取り、モジュールとビルド出力をキャッシュします。さらに go vet、golangci-lint、race 検出器付きのテストを実行します。
ワークフロー
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' }}
jobs:
lint:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
- run: go vet ./...
- uses: golangci/golangci-lint-action@v8
with:
version: latest
test:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- run: go build ./...
- run: go test -race -count=1 -coverprofile=coverage.out ./...
分かりにくい部分の役割
go-version-file: go.modは、モジュールで宣言されたバージョンを使用します。そのため、CI はgoディレクティブに従い、別の場所を更新する必要はありません。- キャッシュは自動で行われます。
setup-gov4 以降は、go.sumをキーとしてモジュールダウンロードキャッシュとビルドキャッシュを保存します。そのため、個別のactions/cacheステップは不要です。cache-dependency-pathが必要になるのは、go.sumがリポジトリのルートにない場合のみです。たとえばモノレポの場合が該当します。 - 2 つのジョブ。 lint とテストは別々のマシンで並列に実行されるため、2 つのうち速いほうがフィードバックとして、遅いほうが全体の所要時間として得られます。
golangci-lint-actionは独自のキャッシュを管理し、差分に注釈を付けます。結果を再現可能にしたい場合は、latestではなく lint のバージョンを固定してください。コピーする前に、アクションの README で現在のメジャーバージョンを確認してください。go test -raceは race 検出器を有効にします。テストは遅くなり、より多くのメモリを使用しますが、実際の並行性のバグを検出できます。必要がなければ削除できますが、まずは試してみることをおすすめします。-count=1は Go のテスト結果キャッシュを無効にします。結果はマシン単位でのみキャッシュされるため、新しい CI ランナーでは違いはありませんが、ローカルで-count=1を指定して実行した場合と同じ結果になります。
バリエーション
バージョンマトリックス
matrix.go: ["1.23", "1.24"] を追加し、go-version-file の代わりに go-version: ${{ matrix.go }} を使用します。ライブラリの場合にのみ必要です。アプリケーションでは、出荷するバージョンでテストしてください。詳しくは マトリックスビルド を参照してください。
データベースのテスト
services: ブロックを追加します。Django テンプレートでは、ヘルスチェック付きの Postgres サービスを示しており、同じブロックを Go でも使用できます。
モノレポ
working-directory: と paths: フィルターを使用し、各モジュールの go.sum を cache-dependency-path で指定します。
ビルドとリリース
go build -trimpath -ldflags="-s -w" を実行し、バイナリを 成果物 としてアップロードするジョブを追加するか、タグ上で GoReleaser を使用します。
macOS または Windows
これらのシステム向けにバイナリを提供する場合は、マトリックスに追加してください。
より高速なマシンで実行する
Go はコンパイルとテストを並列に実行するため、コア数が多いほど直接的に高速化されます。各ジョブの 1 行を変更してください:
runs-on: [self-hosted, Linux, compiler-ci]
このジョブは compiler.dev の新しい 8 vCPU マシンで実行され、元のランナーにフォールバックします。go test -race を使用した React と Go のアプリケーションに対する compiler.dev のベンチマークでは、6m13s から 2m42s に短縮されました。詳細は ベンチマーク を、その他は GitHub Actions で Go を高速化する と 料金 を参照してください。
よくある質問
Go モジュールに actions/cache は必要ですか?
setup-go v4 以降では不要です。デフォルトでモジュールとビルド出力をキャッシュします。
最初の実行が遅く、以降の実行が速いのはなぜですか?
最初の実行でビルドキャッシュが作成されます。以降の実行では、コンパイル済みのパッケージが再利用されます。
すべての push で race 検出器を実行すべきですか?
時間的に余裕があれば、はい。余裕がなければ、main と夜間に実行してください。
古いコードで lint が失敗しないようにするには?
lint アクションで only-new-issues: true を設定してください。
関連記事
- .NET GitHub Actions ワークフローテンプレートNuGet のキャッシュ、リストア、ビルド、テストの手順と SQL Server サービスの選択肢、同時実行制御と権限設定を備えた、.NET 向けの GitHub Actions CI をコピーしてすぐ使えます。
- Django GitHub Actions ワークフローテンプレートPostgres サービスコンテナー、pip キャッシュ、マイグレーションの確認とテストを備え、同時実行制御と権限設定も含む、Django 向けの GitHub Actions CI をコピーしてすぐ使えます。
- DockerビルドのGitHub ActionsワークフローテンプレートBuildx、GitHubのキャッシュレイヤー、mainへのプッシュ時のGHCRへのプッシュを使ってDockerイメージをビルドする、最小限の権限で動作するGitHub Actionsワークフローのコピー&ペースト用サンプルです。
- Elixir GitHub Actions ワークフローテンプレートPostgres サービスと、erlef/setup-beam による deps と _build のキャッシュ、フォーマットとテストを備えた、Elixir と Phoenix 向けの GitHub Actions CI をコピーしてすぐ使えます。