Zum Inhalt springen

Maven GitHub Actions Workflow-Vorlage

Zuletzt aktualisiert am

Dies ist eine funktionierende .github/workflows/ci.yml für ein Maven-Projekt. Sie installiert Java 21 mit aktiviertem Maven-Abhängigkeits-Cache, führt Build sowie Unit- und Integrationstests mit mvn verify aus und behält die Testberichte bei Fehlern.

Der Workflow

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/"

Was die nicht offensichtlichen Teile bewirken

  • cache: maven bei setup-java cached ~/.m2/repository, geschlüsselt über den Hash aller pom.xml-Dateien. Ein separater Cache-Schritt ist nicht nötig. Ändert sich eine pom.xml, wird ein neuer Cache gespeichert.
  • --batch-mode entfernt interaktive Abfragen und Farbcodes. --no-transfer-progress blendet die Fortschrittszeilen der Downloads aus, die sonst das Log mit Tausenden Zeilen füllen würden.
  • verify führt alles bis einschließlich Integrationstests aus (test, package, integration-test). Für eine schnellere Prüfung nur mit Unit-Tests bei Pull Requests verwenden Sie mvn test.
  • Matrix mit Java 17 und 21. Testen Sie die Versionen, die Sie unterstützen. Liefern Sie nur eine Version aus, entfernen Sie die Matrix, um die Minuten zu halbieren. Siehe Matrix-Builds.
  • Artefaktname enthält den Matrixwert. Seit upload-artifact v4 müssen Namen innerhalb eines Laufs eindeutig sein. Siehe Artefakte.
  • Wrapper. Wenn Ihr Repository mvnw enthält, führen Sie ./mvnw aus, damit die Maven-Version festgelegt ist.

Varianten

Parallele Modul-Builds

Fügen Sie -T 1C hinzu, um Module parallel zu bauen, mit einem Thread pro Kern. Dies funktioniert nur, wenn Module und Plugins threadsicher sind.

Integrationstests mit Testcontainers

Docker ist auf ubuntu-latest verfügbar, daher läuft Testcontainers ohne zusätzliche Einrichtung. Der erste Image-Download ist der langsame Teil; siehe Docker-Layer-Caching.

Datenbank-Service-Container

Verwenden Sie einen services:-Block mit Postgres, wie in der Django-Vorlage, und übergeben Sie die URL als Umgebungsvariable.

Deploy- oder Publish-Job

Fügen Sie einen zweiten Job mit needs: build nur auf main hinzu. Für Releases verwenden Sie setup-java mit server-id und server-password, damit Maven die Zugangsdaten aus Secrets lesen kann.

macOS oder Windows

Fügen Sie eine os-Achse nur hinzu, wenn die Bibliothek auf diesen Systemen funktionieren muss.

Auf schnelleren Maschinen ausführen

Maven kann für Tests -T und viele Kerne nutzen. Ändern Sie eine Zeile:

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

Der Job läuft auf einer frischen 8-vCPU-Maschine von compiler.dev, mit automatischem Rückfall auf Ihren ursprünglichen Runner. Der Benchmark von compiler.dev für eine Spring Boot (Maven)-App mit Kafka, Postgres und Testcontainers sank von 1m54s auf 1m12s; siehe Benchmarks. Die Optimierungsliste finden Sie unter Maven auf GitHub Actions beschleunigen, die Preise unter Preise.

FAQ

Brauche ich actions/cache für Maven?

Nein. setup-java mit cache: maven übernimmt das.

Warum wird der Cache nach einer Änderung an einer pom.xml nicht wiederhergestellt?

Der Schlüssel umfasst jede pom.xml, daher erzeugt eine Änderung einen neuen Eintrag. Der alte Cache wird nicht verwendet, wobei Maven möglicherweise nur das Geänderte erneut herunterlädt.

Kann ich Maven-Build-Ausgaben cachen?

Maven hat keinen eingebauten Task-Cache. Ein Remote-Build-Cache erfordert die Maven Build Cache Extension.

Wie führe ich nur geänderte Module aus?

Verwenden Sie -pl mit -amd und einem Schritt für geänderte Dateien, oder wechseln Sie zu einem Build-Tool mit Task-Caching.