コンテンツへスキップ

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

最終更新

これは Maven プロジェクト用の動作する .github/workflows/ci.yml です。Maven の依存関係キャッシュを有効にした状態で Java 21 をインストールし、mvn verify でユニットテストと統合テストをビルド・実行します。失敗時にはテストレポートを保存します。

ワークフロー

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
    strategy:
      fail-fast: false
      matrix:
        java: [17, 21]
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: ${{ matrix.java }}
          cache: maven

      - run: mvn --batch-mode --no-transfer-progress verify

      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: surefire-reports-${{ matrix.java }}
          path: "**/target/surefire-reports/"

分かりにくい部分の役割

  • setup-javaのcache: mavenは、すべてのpom.xmlファイルのハッシュをキーとして、~/.m2/repositoryをキャッシュします。別途キャッシュ用のステップは必要ありません。pom.xmlが変更されると、新しいキャッシュが保存されます。
  • --batch-mode は、対話型のプロンプトやカラーコードを取り除きます。--no-transfer-progress は、ログを何千行も埋めてしまうダウンロード進捗の行を非表示にします。
  • verify は、統合テスト(test、package、integration-test)までのすべてを実行します。プルリクエストでより高速にユニットテストのみを確認したい場合は、mvn test を使用してください。
  • Java 17 と 21 でマトリックスビルドを行います。 サポートするバージョンでテストしてください。1 つのバージョンのみをリリースする場合は、マトリックスを削除すると分数を半分にできます。マトリックスビルドを参照してください。
  • アーティファクト名にマトリックスの値を含めます。 upload-artifact v4 以降では、名前は同じ実行内で一意である必要があります。アーティファクトを参照してください。
  • ラッパー。 リポジトリに mvnw がある場合は、./mvnw を実行して Maven のバージョンを固定してください。

バリエーション

モジュールの並列ビルド

コアごとに 1 スレッドで並列にモジュールをビルドするには、-T 1C を追加します。モジュールとプラグインがスレッドセーフである場合にのみ機能します。

Testcontainers を使った統合テスト

ubuntu-latest では Docker が利用できるため、追加の設定なしで Testcontainers を実行できます。初回のイメージのプルに時間がかかります。Docker レイヤーキャッシュを参照してください。

データベースのサービスコンテナ

Django テンプレートと同様に、Postgres を使った services: ブロックを用意し、URL を環境変数として渡します。

デプロイまたは公開のジョブ

main に対してのみ実行される、needs: build を指定した 2 つ目のジョブを追加します。リリース時には、Maven がシークレットから認証情報を読み取れるように、setup-java で server-id と server-password を使用してください。

macOS または Windows

ライブラリがそれらの OS で動作する必要がある場合にのみ、os の軸を追加してください。

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

Maven はテストで -T と多数のコアを使用できます。1 行を変更してください:

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

このジョブは compiler.dev の新しい 8 vCPU マシンで実行され、元のランナーへの自動フォールバックも備えています。Kafka、Postgres、Testcontainers を使用した Spring Boot(Maven)アプリに対する compiler.dev のベンチマークでは、1m54s から 1m12s に短縮されました。詳細はベンチマークを参照してください。チューニングの一覧はGitHub Actions で Maven を高速化するにあり、料金は料金のページにあります。

よくある質問

Maven に actions/cache は必要ですか?

いいえ。cache: maven を指定した setup-java がその役割を果たします。

pom.xml を編集した後、キャッシュが復元されないのはなぜですか?

キーにはすべての pom.xml が含まれるため、変更があると新しいエントリが作成されます。古いキャッシュは使用されませんが、Maven は変更された部分のみを再ダウンロードする場合があります。

Maven のビルド出力をキャッシュできますか?

Maven には組み込みのタスクキャッシュがありません。リモートビルドキャッシュには Maven Build Cache Extension が必要です。

変更されたモジュールのみを実行するにはどうすればよいですか?

-pl と -amd を組み合わせて、変更されたファイルを調べるステップを使用するか、タスクキャッシュに対応したビルドツールに移行してください。