コンテンツへスキップ

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

最終更新

これは Gradle ビルド(Spring Boot、Kotlin、Android ライブラリのプロジェクトなど)向けの、そのまま動作する .github/workflows/ci.yml です。gradle/actions/setup-gradle で Gradle の状態をキャッシュしたうえで、./gradlew build を実行します。

ワークフロー

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:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 21

      - uses: gradle/actions/setup-gradle@v4
        with:
          cache-read-only: ${{ github.ref != 'refs/heads/main' }}

      - run: ./gradlew build --no-daemon

      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: test-reports
          path: "**/build/reports/tests/"

分かりにくい部分の役割

  • setup-java で JDK をインストールします。Temurin は広く使われている無償のビルドです。プロジェクトが対象とする Java バージョンを使用してください。
  • gradle/actions/setup-gradle@v4 は gradle/gradle-build-action の代わりになります。Gradle のユーザーホーム(ダウンロード済みの依存関係、ラッパーの配布物、ビルドキャッシュのエントリ)をキャッシュし、ジョブサマリーを書き出します。setup-java に cache: gradle を追加する必要はありません。両方を使うと作業が重複するだけです。
  • cache-read-only を指定すると、プルリクエストの実行ではキャッシュを復元するだけで保存は行われません。書き込みを行うのは main のみで、これによりキャッシュを整理された状態に保ち、ほぼ同一のエントリが大量に作られるのを防ぎます。詳しくは CI における Gradle キャッシュ を参照してください。
  • ./gradlew はラッパーを実行するため、Gradle のバージョンはプロジェクトが固定したものになります。サプライチェーンの安全性のためにラッパー JAR のチェックサムを検証したい場合は、最初のステップとして gradle/actions/wrapper-validation@v4 を追加してください。
  • --no-daemon は、一度きりの実行環境でデーモンを常駐させないようにします。
  • 失敗時のアーティファクト。 if: failure() によるアップロードは、テストが失敗したときに HTML のテストレポートを保存します。詳しくは アーティファクト を参照してください。
  • 30 分のタイムアウト。 大規模なマルチモジュールビルドは時間がかかることがあります。通常にかかる時間がわかったら、この値を短く調整してください。

バリエーション

複数バージョンまたは複数 OS のマトリクス

matrix.java: [17, 21] を追加し、java-version: ${{ matrix.java }} を設定します。ライブラリの場合に便利です。詳しくは マトリクスビルド を参照してください。

Gradle ビルドキャッシュ

gradle.properties で org.gradle.caching=true を有効にします。setup-gradle を使うと、ローカルのビルドキャッシュが保存された状態に含まれるため、変更のないタスクはスキップされます。共有の リモートビルドキャッシュ を使う場合は、settings.gradle でリモートキャッシュサーバーを設定してください。

データベースのテスト

Django テンプレートのように、Postgres 用に services: ブロックを使います。Testcontainers を使う場合は、ランナーで Docker が利用できるため、services ブロックは不要です。

Android

android-actions/setup-android@v3 を追加し、./gradlew assembleDebug testDebugUnitTest lintDebug を実行します。

デプロイジョブ

main でのみ実行される、needs: build を指定した 2 つ目のジョブを追加し、クラウドの認証情報には OIDC を使います。

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

Gradle は複数のコアを使って並列に処理し、高速なディスクの恩恵を受けます。1 行だけ変更してください:

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

このジョブは compiler.dev の新しい 8 vCPU マシンで実行され、元のランナーにフォールバックします。compiler.dev のベンチマークでは、Angular と Spring Boot(Gradle)のアプリが 6m57s から 2m18s に短縮されました。詳しくは ベンチマーク を、チューニングの全体像は GitHub Actions で Gradle を高速化する を、料金は 料金 を参照してください。

よくある質問

setup-gradle で十分ですか、それとも actions/cache が必要ですか?

setup-gradle で十分です。キャッシュキーの管理と後片付けを自動で行います。

プルリクエストでキャッシュが保存されないのはなぜですか?

cache-read-only の設定によるものです。プルリクエストでもキャッシュを書き込ませたい場合は、この設定を削除してください。

CI で Gradle デーモンを使うべきですか?

単発のビルドでは通常使用しません。無効にしない限り、ラッパーはデーモンを起動します。

テストを高速化するにはどうすればよいですか?

maxParallelForks を有効にし、ジョブ間でテストを分割してください。詳しくは テストのシャーディング を参照してください。