コンテンツへスキップ

GitHub ActionsでGradleを高速化する

最終更新

GitHub ActionsでGradleを高速化するには、キャッシュにはgradle/actions/setup-gradleを使用し、Gradleのビルドキャッシュ、構成キャッシュ、並列実行を有効にして、テストを複数のコアに分散させます。Gradleは、どのタスクの出力がまだ有効かを把握しているため、キャッシュとの相性が良いです。ただし、実行をまたいで保持されるキャッシュを用意する必要があります。

このガイドでは、設定内容と完全なワークフローを示します。全体的な進め方については、GitHub Actionsを高速化する方法をご覧ください。

独自のキャッシュ実装ではなくsetup-gradleを使用する

gradle/actions/setup-gradleはGradle公式のアクションです。公式ドキュメントによると、キャッシュはenhancedプロバイダーによりデフォルトで有効になっています。以下の動作を把握しておくと役立ちます。

  • キャッシュへの書き込みはデフォルトブランチのジョブのみが行います。その他のブランチは読み取りのみを行います。これにより、PRによる不要な書き込みからキャッシュを保護します。
  • デーモンは、キャッシュが保存される前にpostステップで停止されます。
  • キャッシュのクリーンアップは、ジョブ内のすべてのGradleビルドが成功した場合にのみ行われます。
  • cache-read-only: trueを指定すると、ジョブは読み取りのみを行い、書き込みは行いません。特殊なタスクを実行するジョブで使用するとよいでしょう。
  • cache-encryption-keyを設定すると、構成キャッシュのデータを保存できます。これはbase64形式のAESキーで、openssl rand -base64 16で生成し、シークレットとして保存します。
- uses: actions/checkout@v7
- uses: actions/setup-java@v6
  with:
    distribution: temurin
    java-version: 21
- uses: gradle/actions/setup-gradle@v6
- run: ./gradlew build --scan

setup-javaには独自のcache: gradleオプションがあります。両方を有効にしないでください。setup-gradleの方が多くの機能を備えており、両者が競合する可能性があります。

CI向けのgradle.properties

ビルド時間に最も大きく影響する設定は3つあります。ローカルビルドにも適用されるようgradle.propertiesに記述するか、フラグとして渡してください。

org.gradle.caching=true
org.gradle.parallel=true
org.gradle.configuration-cache=true
org.gradle.jvmargs=-Xmx3g -XX:+UseParallelGC
  • ビルドキャッシュ(org.gradle.caching)は、入力が変化していないタスクの出力(コンパイル済みクラスやテスト結果など)を再利用します。setup-gradleを使用すると、これはGitHub Actionsのキャッシュに保存されます。キャッシュがヒットすると、モジュール全体がFROM-CACHEと表示されます。
  • 並列実行(org.gradle.parallel)は、独立したサブプロジェクトを同時に実行します。マルチモジュールのビルドに効果があり、単一モジュールには効果がありません。
  • 構成キャッシュ(org.gradle.configuration-cache)は構成フェーズの結果を保存するため、以降のビルドではそのフェーズをスキップします。これにはキャッシュに対応したプラグインが必要で、修正されるまでは違反によりビルドが失敗する場合があります。恒久的に有効にする前に、一度./gradlew build --configuration-cacheを実行し、レポートを確認してください。プラグインの互換性はGradleの公式ドキュメントに掲載されています。
  • JVMのメモリ。標準の2 vCPUホステッドランナーは7 GBのRAMを備えているため、ヒープサイズが重要になります。小さすぎるとGradleがガベージコレクションに時間を費やし、大きすぎるとランナーがスワップします。

テストの並列化

Gradleは、デフォルトではテストクラスを1つのJVMで実行します。build.gradle.ktsの2つのプロパティを使用すると、より多くのコアを活用できます。

tasks.withType<Test>().configureEach {
    maxParallelForks = (Runtime.getRuntime().availableProcessors() / 2).coerceAtLeast(1)
    forkEvery = 0
    useJUnitPlatform()
}

maxParallelForksは、1つのモジュールに対してその数のテストJVMを並列で起動します。各フォークはメモリと独自のデータベース接続を使用するため、データベースを共有するテストではフォークごとに分離が必要です(例えば、フォークごとにスキーマやコンテナを用意します)。分離しないと競合します。Testcontainersを使用する場合、フォークごとのコンテナはメモリ使用量を増やします。テストをジョブ間でシャーディングする場合は、Gradleの--testsフィルターや、実行時間に基づいて分割するプラグインを使用できます。詳しくはGitHub Actionsでのテストシャーディングをご覧ください。

作業の重複を避ける

  • buildはすべてを実行します。さらにtestとcheckを個別に実行すると、最新の状態であったタスクを再実行することになります。Gradleは1回の呼び出し内では最新のタスクをスキップしますが、ビルドキャッシュが有効でない限り、新しいVM上の個別のステップ同士では出力を共有しません。
  • 一度実行し、成果物を渡す。1つのジョブで./gradlew assembleを使ってコンパイルし、その後、ビルドキャッシュから復元する複数のジョブでテストを実行します。
  • 不要な処理を省く。PRチェックでは-x javadocや-x dokkaHtmlを使用し、ドキュメントの生成はリリース時のみに行います。
  • ラッパー。配布物が固定されるよう、常に./gradlewを使用してください。setup-gradleは、ダウンロード済みのラッパー配布物をキャッシュします。
  • Docker。Gradleからイメージをビルドする場合は、Gradleの設定よりもレイヤーキャッシュの方が重要です。CIでのDockerレイヤーキャッシュをご覧ください。

ビルドスキャンを読む

--scan(またはDevelocityプラグイン)を使用すると、タスクのタイムライン、キャッシュのヒット/ミスの理由、依存関係の解決に時間がかかっている箇所を確認できます。タスクが毎回キャッシュをミスする場合、スキャンでどの入力が変化したかが分かります。よくある原因は、出力に埋め込まれたタイムスタンプ、絶対パス、そして1.+のような固定されていない動的バージョンです。

CPU コア数を増やす効果

Gradleはプロジェクトとテストを並列化し、JVMコンパイラはマルチスレッドで動作するため、ほかのスタックよりも恩恵が大きくなります。ベンチマークでは、Angular + Spring Boot(Gradle)+ Postgresのプロジェクトが、GitHubホステッドランナーでの6m57sから、compiler.devでは2m18s(3.0x)に短縮されました。これは当社が計測した中で最大の高速化です。計測は2026年10月8日に、10個のテストシャードと実際のデータベースを使ったCI全体の実行から得ました。また、JVMビルドにとって有利な、7 GBではなく16 GBのメモリも利用できていました。

結果は、モジュールグラフの並列性の度合いによって変わります。単一の大きなモジュールでは効果は小さくなります。計測するには、1行をruns-on: [self-hosted, Linux, compiler-ci]に変更してください。料金と比較もご覧ください。関連ページ: Gradleテンプレート、Mavenガイド、GitHub Actionsのキャッシュ。

よくある質問

setup-java cache: gradleとsetup-gradleのどちらを使うべきですか?

gradle/actions/setup-gradleを使用してください。より多くのキャッシュを扱い、キャッシュのライフサイクルを管理します。両方を有効にしないでください。

なぜメインブランチだけがGradleキャッシュに書き込むのですか?

PRのビルドで共有キャッシュがいっぱいになったり、既存のキャッシュが削除されたりするのを防ぐためです。その他のブランチは、メインブランチが保存したキャッシュを引き続き読み取ります。cache-read-onlyで変更できます。

Gradleの構成キャッシュは有効にしても安全ですか?

最近のGradleバージョンでは安定していますが、各プラグインがこれに対応している必要があります。まず--configuration-cacheを付けて試し、報告された問題を修正してください。

テストのフォークは何並列にすべきですか?

まずはコア数の半分から始め、メモリの使用量を確認してください。共有データベースを使うテストでは、フォークごとに分離が必要です。

このGradleビルドをcompiler.devで実行 カード登録不要 · 200 無料分

無料で試す