Gradle in GitHub Actions beschleunigen
Zuletzt aktualisiert am
Um Gradle in GitHub Actions zu beschleunigen, verwenden Sie gradle/actions/setup-gradle für das Caching, aktivieren den Gradle-Build-Cache, den Configuration-Cache und die parallele Ausführung und verteilen Tests auf mehrere Kerne. Gradle eignet sich gut für Caching, weil es weiß, welche Task-Ausgaben noch gültig sind, aber nur, wenn Sie ihm einen Cache geben, der zwischen den Läufen erhalten bleibt.
Diese Anleitung zeigt die Einstellungen und einen vollständigen Workflow. Den allgemeinen Ansatz erläutert , wie Sie GitHub Actions beschleunigen.
setup-gradle statt eigenem Caching verwenden
gradle/actions/setup-gradle ist die offizielle Action von Gradle. Laut Dokumentation ist das Caching standardmäßig aktiv und verwendet den Provider enhanced. Einige Verhaltensweisen sollten Sie kennen:
- Nur Jobs auf dem Standard-Branch schreiben in den Cache. Andere Branches lesen daraus. So bleibt der Cache frei von PR-Rauschen.
- Daemons werden im Post-Schritt beendet, bevor der Cache gespeichert wird.
- Der Cache wird nur bereinigt, wenn alle Gradle-Builds im Job erfolgreich sind.
cache-read-only: truesorgt dafür, dass ein Job nur liest und nie schreibt. Das kann für Jobs sinnvoll sein, die ungewöhnliche Tasks ausführen.- Daten des Configuration-Cache können gespeichert werden, wenn Sie
cache-encryption-keysetzen (ein Base64-AES-Schlüssel, erzeugt mitopenssl rand -base64 16und als Secret hinterlegt).
- 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 bietet eine eigene Option cache: gradle. Aktivieren Sie nicht beide, denn setup-gradle kann mehr und die beiden können sich gegenseitig stören.
gradle.properties für CI
Drei Einstellungen beeinflussen die Build-Zeit stärker als alles andere. Setzen Sie sie in gradle.properties, damit auch lokale Builds davon profitieren, oder übergeben Sie sie als Flags:
org.gradle.caching=true
org.gradle.parallel=true
org.gradle.configuration-cache=true
org.gradle.jvmargs=-Xmx3g -XX:+UseParallelGC
- Der Build-Cache (
org.gradle.caching) verwendet die Ausgaben von Tasks wieder, deren Eingaben sich nicht geändert haben, etwa kompilierte Klassen und Testergebnisse. Mitsetup-gradlewird dieser im GitHub Actions Cache gespeichert. Bei einem Cache-Treffer werden ganze Module alsFROM-CACHEangezeigt. - Parallel (
org.gradle.parallel) führt unabhängige Teilprojekte gleichzeitig aus. Das hilft bei Multi-Modul-Builds und bringt bei einem einzelnen Modul nichts. - Configuration-Cache (
org.gradle.configuration-cache) speichert das Ergebnis der Konfigurationsphase, sodass Wiederholungs-Builds sie überspringen. Dafür brauchen Sie Plugins, die ihn unterstützen, und manche Builds schlagen mit Verstößen fehl, bis diese behoben sind. Führen Sie./gradlew build --configuration-cacheeinmal aus und lesen Sie den Bericht, bevor Sie ihn dauerhaft aktivieren. Die Gradle-Dokumentation listet die Plugin-Kompatibilität auf. - JVM-Speicher. Ein Standard-Hosted-Runner mit 2 vCPU hat 7 GB RAM, daher ist die Heap-Größe wichtig. Ist sie zu klein, verbringt Gradle viel Zeit mit der Garbage Collection. Ist sie zu groß, lagert der Runner aus.
Test-Parallelität
Gradle führt Testklassen standardmäßig in einer JVM aus. Zwei Eigenschaften in build.gradle.kts nutzen mehr Kerne:
tasks.withType<Test>().configureEach {
maxParallelForks = (Runtime.getRuntime().availableProcessors() / 2).coerceAtLeast(1)
forkEvery = 0
useJUnitPlatform()
}
maxParallelForks startet so viele Test-JVMs parallel für ein Modul. Jeder Fork belegt Speicher und eigene Datenbankverbindungen. Tests, die sich eine Datenbank teilen, brauchen daher eine Isolation pro Fork (zum Beispiel ein Schema oder einen Container pro Fork), sonst kollidieren sie. Mit Testcontainers vervielfacht sich der Speicherbedarf durch Container pro Fork. Wenn Sie Tests stattdessen auf mehrere Jobs verteilen, funktioniert der Filter --tests von Gradle oder ein Plugin, das nach Laufzeit aufteilt; siehe Test-Sharding in GitHub Actions.
Doppelte Arbeit vermeiden
buildführt alles aus. Wenn Sie zusätzlichtestundcheckseparat starten, werden bereits aktuelle Tasks erneut ausgeführt. Gradle überspringt aktuelle Tasks innerhalb eines Aufrufs, aber getrennte Schritte auf einer frischen VM teilen keine Ausgaben, solange der Build-Cache nicht aktiv ist.- Einmal bauen, Artefakte weitergeben. Kompilieren Sie in einem Job mit
./gradlew assembleund führen Sie die Tests in mehreren Jobs aus, die aus dem Build-Cache wiederherstellen. - Überflüssiges weglassen. Verwenden Sie
-x javadocoder-x dokkaHtmlin PR-Prüfungen und erzeugen Sie die Dokumentation nur beim Release. - Wrapper. Verwenden Sie immer
./gradlew, damit die Distribution festgelegt ist.setup-gradlecached die heruntergeladene Wrapper-Distribution. - Docker. Wenn Sie Images aus Gradle bauen, ist das Layer-Caching wichtiger als die Gradle-Einstellungen. Siehe Docker-Layer-Caching in CI.
Build-Scan auswerten
--scan (oder das Develocity-Plugin) zeigt Task-Zeitleisten, Gründe für Cache-Treffer und -Fehlschläge sowie langsame Dependency-Auflösung. Verfehlt ein Task den Cache bei jedem Lauf, zeigt der Scan, welche Eingabe sich geändert hat. Häufige Ursachen sind Zeitstempel in Ausgaben, absolute Pfade und nicht festgelegte dynamische Versionen wie 1.+.
Was mehr CPU-Kerne bringen
Gradle parallelisiert Projekte und Tests, und der JVM-Compiler arbeitet mehrfädig, daher profitiert es mehr als die meisten anderen Stacks. In unseren Benchmarks sank die Laufzeit eines Angular- + Spring Boot (Gradle)- + Postgres-Projekts von 6m57s auf einem von GitHub gehosteten Runner auf 2m18s auf compiler.dev (3.0x). Das ist unsere größte Beschleunigung, gemessen an einem vollständigen CI-Lauf mit 10 Test-Shards und einer echten Datenbank am 8. Oktober 2026. Außerdem stand mehr Arbeitsspeicher zur Verfügung, 16 GB statt 7 GB, was bei JVM-Builds hilft.
Die Ergebnisse hängen davon ab, wie parallel Ihr Modulgraph aufgebaut ist. Ein einzelnes großes Modul gewinnt weniger. Zum Messen ändern Sie eine Zeile auf runs-on: [self-hosted, Linux, compiler-ci]; siehe Preise und Vergleich. Verwandt: die Gradle-Vorlage, die Maven-Anleitung und das Caching in GitHub Actions.
FAQ
Soll ich setup-java mit cache: gradle oder setup-gradle verwenden?
Verwenden Sie gradle/actions/setup-gradle. Es cached mehr und verwaltet den Lebenszyklus des Caches. Aktivieren Sie nicht beide.
Warum schreibt nur der Main-Branch in den Gradle-Cache?
So verhindern Sie, dass PR-Builds den gemeinsamen Cache füllen und verdrängen. Branches lesen weiterhin, was main gespeichert hat. Sie können das mit cache-read-only ändern.
Ist der Gradle-Configuration-Cache sicher zu aktivieren?
In aktuellen Gradle-Versionen ist er stabil, aber jedes Plugin muss ihn unterstützen. Testen Sie ihn zuerst mit --configuration-cache und beheben Sie gemeldete Probleme.
Wie viele parallele Test-Forks sollte ich verwenden?
Beginnen Sie mit der Hälfte der Kerne und beobachten Sie den Speicher. Tests, die eine gemeinsame Datenbank nutzen, benötigen eine Isolation pro Fork.
Verwandt
- TypeScript-Monorepo in GitHub Actions beschleunigenTypprüfung und Linting in TypeScript-Monorepos auf GitHub Actions beschleunigen: inkrementelles tsc, Projektreferenzen, Lint-Caches und parallele Jobs.
- Playwright im Monorepo mit GitHub Actions beschleunigenPlaywright-E2E-Tests in einem Node-Monorepo auf GitHub Actions beschleunigen: App einmal bauen, E2E überspringen, wenn sich die Web-App nicht ändert.
- CI-Geschwindigkeits-Badge in Ihre README einfügenZeigen Sie die Geschwindigkeit Ihrer CI mit einem README-Badge: die mediane Laufzeit Ihrer Repository-Workflows auf GitHub Actions, automatisch aktualisiert.
- Gradle-Builds in GitHub Actions cachenGradle-Abhängigkeiten und Build-Cache in GitHub Actions mit gradle/actions/setup-gradle oder actions/cache cachen. Keys, PRs, Bereinigung, Checks.