Zum Inhalt springen

Gradle GitHub Actions Workflow-Vorlage

Zuletzt aktualisiert am

Dies ist ein funktionierendes .github/workflows/ci.yml für einen Gradle-Build, etwa für ein Spring Boot-, Kotlin- oder Android-Bibliotheksprojekt. Es verwendet gradle/actions/setup-gradle, das den Zustand von Gradle cached, und führt anschließend ./gradlew build aus.

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

Was die nicht offensichtlichen Teile bewirken

  • setup-java installiert das JDK. Temurin ist eine weit verbreitete, kostenlose Distribution. Verwenden Sie die Java-Version, auf die Ihr Projekt abzielt.
  • gradle/actions/setup-gradle@v4 ersetzt gradle/gradle-build-action. Es cached das Gradle-User-Home (heruntergeladene Abhängigkeiten, Wrapper-Distribution, Build-Cache-Einträge) und schreibt eine Job-Zusammenfassung. Sie benötigen cache: gradle bei setup-java zusätzlich nicht; beides zu verwenden verdoppelt nur die Arbeit.
  • cache-read-only sorgt dafür, dass Pull-Request-Läufe den Cache zwar laden, aber nicht speichern. Nur main schreibt, was den Cache sauber hält und viele nahezu identische Einträge vermeidet. Siehe Gradle-Caching in CI.
  • ./gradlew führt den Wrapper aus, sodass die Gradle-Version die ist, die das Projekt festlegt. Fügen Sie gradle/actions/wrapper-validation@v4 als ersten Schritt hinzu, wenn Sie die Prüfsumme des Wrapper-JARs zur Absicherung der Lieferkette verifizieren möchten.
  • --no-daemon verhindert, dass in einer einmaligen Umgebung ein Daemon am Laufen gehalten wird.
  • Fehler-Artefakt. Der Upload mit if: failure() speichert die HTML-Testberichte, wenn Tests fehlschlagen. Siehe Artefakte.
  • 30 Minuten Timeout. Große Multi-Modul-Builds können langsam sein; setzen Sie den Wert niedriger, sobald Sie Ihre übliche Laufzeit kennen.

Varianten

Matrix für mehrere Versionen oder Betriebssysteme

Fügen Sie matrix.java: [17, 21] hinzu und setzen Sie java-version: ${{ matrix.java }}. Nützlich für Bibliotheken. Siehe Matrix-Builds.

Gradle-Build-Cache

Aktivieren Sie org.gradle.caching=true in gradle.properties. Mit setup-gradle wird der lokale Build-Cache im gespeicherten Zustand abgelegt, sodass unveränderte Tasks übersprungen werden. Für einen gemeinsam genutzten Remote-Build-Cache konfigurieren Sie einen Remote-Cache-Server in settings.gradle.

Datenbanktests

Verwenden Sie einen services:-Block mit Postgres, wie in der Django-Vorlage. Mit Testcontainers ist kein Service-Block nötig, da Docker auf dem Runner verfügbar ist.

Android

Fügen Sie android-actions/setup-android@v3 hinzu und führen Sie ./gradlew assembleDebug testDebugUnitTest lintDebug aus.

Deploy-Job

Fügen Sie einen zweiten Job mit needs: build nur für main hinzu und verwenden Sie OIDC für Cloud-Zugangsdaten.

Auf schnelleren Maschinen ausführen

Gradle parallelisiert über alle Kerne und profitiert von schnellem Speicher. Ä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 Rückfall auf Ihren ursprünglichen Runner. Im Benchmark von compiler.dev sank die Laufzeit einer Angular- und Spring Boot-(Gradle-)App von 6m57s auf 2m18s; siehe Benchmarks. Die vollständige Optimierung finden Sie unter Gradle auf GitHub Actions beschleunigen, die Preise unter Preise.

FAQ

Reicht setup-gradle, oder brauche ich actions/cache?

Es reicht. Es übernimmt die Cache-Schlüssel und die Bereinigung für Sie.

Warum wird der Cache bei Pull Requests nicht gespeichert?

Das liegt an der Einstellung cache-read-only. Entfernen Sie sie, wenn Pull Requests ebenfalls Caches schreiben sollen.

Sollte ich den Gradle-Daemon in CI verwenden?

Bei einzelnen Builds in der Regel nicht. Der Wrapper startet ohnehin einen Daemon, sofern Sie ihn nicht deaktivieren.

Wie beschleunige ich Tests?

Aktivieren Sie maxParallelForks und verteilen Sie die Tests per Sharding auf mehrere Jobs. Siehe Test-Sharding.