GitHub Actionsワークフローを高速化する方法
最終更新日
CIが遅いと、二重のコストがかかります。開発者は待たされ、実行時間に応じて料金も支払うことになります。多くのワークフローは、プロダクトのコードを一行も変えることなく、実行時間の3分の1から半分を削減できます。このガイドでは、まず遅い箇所を特定し、効果の大きい順に修正する方法を説明します。
変更する前に計測する
最近の実行を開き、合計時間ではなくステップごとの所要時間を確認してください。Actions UIでジョブをクリックし、ステップを展開すると、それぞれの所要時間が表示されます。最も遅いワークフローについて、次の3つの数値を書き出してください。キューで待った時間、セットアップ(チェックアウト、ツールチェーン、依存関係のインストール)にかかった時間、実際のビルドやテストのステップにかかった時間です。
GitHub CLIを使って所要時間を取得することもできます。
gh run list --workflow ci.yml --limit 30 --json databaseId,createdAt,updatedAt,conclusion
gh run view <run-id> --json jobs --jq '.jobs[] | {name, started: .startedAt, done: .completedAt}'
よくある結果として、最大のボトルネックはテストではなくセットアップです。これは良いニュースです。セットアップは最もキャッシュしやすい部分だからです。
不要な処理を止める
最も安い分は、そもそも実行されない分です。次の3つの変更で、実行全体を減らせます。
置き換えられた実行をキャンセルする。PRに対して二度プッシュされた場合、最初の実行は無駄になります。
concurrency:
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
条件により、main上の実行同士がキャンセルし合うことはないため、マージのたびに完全な実行が行われます。
関係のない変更では実行をスキップする。ドキュメントの編集でテストスイートが起動されるべきではありません。
on:
pull_request:
paths-ignore:
- "docs/**"
- "**.md"
スキップされたワークフローが必須チェックになっている場合、PRはそれを永遠に待ち続けます。ステータスを報告する小さな常時実行ジョブを使うか、トリガーではなくワークフロー内でパス検出ステップを使ってフィルタリングしてください。
タイムアウトを設定する。ジョブのデフォルトのタイムアウトは360分です。ハングしたテストは6時間分の課金時間を消費しかねません。すべてのジョブにtimeout-minutes: 15(または通常の実行時間の2倍)を設定してください。
ダウンロードするものをキャッシュする
依存関係のインストールとツールチェーンのダウンロードは、実行のたびに繰り返されます。setup-*アクションにはキャッシュ機能が組み込まれています。
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
setup-python、setup-java、setup-goにも同じオプションがあります。それ以外には、ロックファイルのハッシュから作成したキーを使ってactions/cacheを使用してください。キー、restore-keys、制限についてはGitHub Actionsでのキャッシュガイドで解説しています。キャッシュキービルダーを使えば、YAMLを自動で生成できます。
パッケージマネージャーのダウンロードキャッシュをキャッシュし、クリーンインストールを実行できる場合は、node_modulesを直接キャッシュしないでください。復元されたnode_modulesによって、壊れたロックファイルが隠れてしまうことがあります。
ジョブを並列で実行する
長いジョブが1つだけのワークフローは、直列のパイプラインです。独立した作業は別々のジョブに分割し、同時に実行させてください。lint、型チェック、ユニットテスト、ビルドは互いに依存しないため、分割できます。
jobs:
lint:
runs-on: ubuntu-latest
steps: [...]
test:
runs-on: ubuntu-latest
steps: [...]
build:
runs-on: ubuntu-latest
steps: [...]
ジョブごとにセットアップのコストがかかるため、分割が効果を発揮するのはセットアップがキャッシュされ、短い場合だけです。長い単一のテストジョブの場合は、代わりにシャーディングしてください。テストのシャーディングと並列テストとテストシャーディングプランナーを参照してください。
各ステップの処理を減らす
- 浅いチェックアウト。
actions/checkoutはデフォルトで1つのコミットのみを取得します(fetch-depth: 1)。影響のあるパッケージの検出など、履歴を必要とするステップがない限り、fetch-depth: 0は設定しないでください。 - 変更されたものだけをビルドする。モノレポでは、影響を受けるプロジェクトのみを実行してください。NxまたはTurborepoを使ったモノレポCIを参照してください。
- ビルド成果物を再利用する。一度ビルドし、
actions/upload-artifactでアップロードして、後のジョブでダウンロードしてください。各ジョブで再ビルドする必要はありません。 - Docker。レイヤーキャッシュにより、5分かかるイメージのビルドが30秒程度になることがよくあります。CIでのDockerレイヤーキャッシュを参照してください。
- マトリックスを絞る。OSやバージョンを追加するたびに、コストは掛け算で増えます。マトリックスビルドを正しく使うを参照してください。
より大きく高速なランナーを使う
プライベートリポジトリのデフォルトのubuntu-latestランナーは、2 vCPUと7 GBのRAMです。ビルドやテストが複数のコアを使う場合(コンパイラ、バンドラー、pytest -n auto、go testなど)、コアを増やすと直接効果があります。GitHubの4コアの大規模ランナーは、ランナー料金ページによると、2コアの$0.006に対して1分あたり$0.012かかります。4コアで2倍以上速くなるジョブは、速度だけでなくコストの面でも有利です。
ランナースペックツールでは、すべてのサイズとラベルを確認できます。コスト計算ツールでは、サイズを変更した場合に月額料金がどう変わるかを確認できます。すべてを一度に切り替える前に、1つのワークフローで試してください。シングルスレッドのステップは、コアを増やしても効果がありません。
キューの待ち時間を確認する
ジョブの開始前に待ち時間が発生している場合、YAMLの変更では解決しません。原因は、プランの同時実行数の上限(同時に実行できるジョブ数はGitHubのプランによって異なります)か、小さなジョブが多すぎることです。ジョブ数を減らし、1つあたりの規模を大きくすると、キューイングを減らせます。セルフホステッドランナーやサードパーティ製のランナーを使えば、上限を取り除けます。
作業の進め方の一例
concurrencyとtimeout-minutesを追加する(10分、リスクなし)。- 依存関係のキャッシュを有効にする。
- lint、テスト、ビルドを並列ジョブに分割する。
- 最も遅いテストジョブをシャーディングする。
- 最も遅いジョブで大きめのランナーを試し、時間だけでなく実行ごとのコストを比較する。
よくある質問
CI時間の目安はどれくらいですか?
多くのチームは、プルリクエストへのフィードバックを10分未満にすることを目指しています。DORAの研究では、短いフィードバックループと優れたデリバリーパフォーマンスの関連が示されています。最も遅い必須チェックの目標値を一つ決め、毎週追跡してください。
ランナーを大きくすれば、CIは必ず速くなりますか?
いいえ。並列処理できる作業でのみ効果があります。ネットワークからのダウンロード、単一スレッドのスクリプト、外部サービスの応答待ちは、コア数を増やしても速くなりません。
キャッシュを使うとビルドが不正確になりますか?
キーに内容へ影響するすべてを含めていれば問題ありません。通常はロックファイルのハッシュとOSを含めます。古いキャッシュが使われるのは、ほとんどの場合キーの範囲が広すぎることが原因です。
キューの待ち時間に課金されますか?
いいえ。GitHubが課金するのはジョブの実行時間のみです。ただし、キューの待ち時間は開発者の作業を遅らせます。
自分のジョブで計測する
より高速なマシンが実際のワークフローにどのような効果をもたらすかを確認したい場合は、compiler.devで同じジョブを高速なランナー上で実行できます。実行時間とコストを並べて表示する比較モードもあります。当社のベンチマークでは、測定した18のスタック(15は高速化、2は同等、1は低速化)において、GitHubの2コアランナーと比べて中央値で1.5倍高速でした。結果はジョブの並列性によって変わるため、想定ではなく計測することをおすすめします。
関連記事
- GitHub ActionsでTypeScriptモノレポを高速化するGitHub Actionsで TypeScriptモノレポの型チェックとリンターを高速化する: インクリメンタルtsc、プロジェクト参照、Lintキャッシュ、並列ジョブ
- GitHub ActionsでモノレポのPlaywrightを高速化するGitHub Actions で Node モノレポの Playwright E2E テストを高速化: アプリを一度だけビルドし、Web アプリに変更がないときは E2E をスキップし、シャーディングとレポートのマージを行います。
- READMEにCIの速度バッジを追加するREADME のバッジで CI の速さを表示しましょう。リポジトリの GitHub Actions 実行時間の中央値が自動で更新されます。公開リポジトリは無料です。
- GitHub Actionsで.NETを高速化するGitHub Actions で .NET のビルドを高速化する: setup-dotnet による NuGet キャッシュ、--no-restore、--no-build、並列の dotnet test、SQL Server サービス。