Flutter GitHub Actions Workflow-Vorlage
Zuletzt aktualisiert am
Dies ist eine funktionsfähige .github/workflows/ci.yml für eine Flutter-App. Sie installiert Flutter mit Caching, löst Pakete auf, führt flutter analyze und flutter test aus und baut in einem zweiten Job ein Debug-Android-APK.
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:
test:
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
- uses: subosito/flutter-action@v2
with:
channel: stable
cache: true
- run: flutter pub get
- run: dart format --output=none --set-exit-if-changed .
- run: flutter analyze
- run: flutter test --coverage
android:
needs: test
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 17
- uses: subosito/flutter-action@v2
with:
channel: stable
cache: true
- uses: gradle/actions/setup-gradle@v4
with:
cache-read-only: ${{ github.ref != 'refs/heads/main' }}
- run: flutter pub get
- run: flutter build apk --debug
Was die nicht offensichtlichen Teile bewirken
subosito/flutter-action@v2lädt das Flutter SDK herunter.cache: truecacht das SDK selbst, sodass spätere Läufe den großen Download überspringen. Pub-Pakete werden standardmäßig nicht gecacht;flutter pub getliest auf dem Runner aus dem Pub-Cache, was meist schnell geht. Bei umfangreichen Abhängigkeitsbäumen fügen Sie einenactions/cache-Schritt für~/.pub-cachehinzu, mitpubspec.lockals Schlüssel.channel: stablefolgt immer der neuesten stabilen Version. Für reproduzierbare Builds fixieren Sieflutter-version: 3.x.x(die Version, mit der Ihr Team entwickelt) und behaltenchannel: stablebei.- Zwei Jobs. Analyse und Tests sind schnell und liefern frühes Feedback. Der Android-Build ist aufwendiger, daher wartet er mit
needs: testund läuft nicht, wenn Tests fehlschlagen. Entfernen Sieneeds, um parallel zu laufen. Das verkürzt die Wartezeit, erhöht aber die Kosten. dart format ... --set-exit-if-changedschlägt fehl, wenn Dateien nicht formatiert sind, ohne Änderungen zu schreiben.setup-gradlecacht die Gradle-Dateien, die der Android-Build herunterlädt. Siehe Gradle-Caching.- Java 17. Aktuelle Android-Gradle-Plugins benötigen mindestens Java 17. Passen Sie dies an die Anforderungen Ihres Projekts an.
Varianten
iOS-Builds
Fügen Sie einen Job auf macos-latest mit flutter build ios --no-codesign hinzu. macOS-Minuten sind kostspielig, daher führen Sie ihn nur auf main aus, nicht bei jedem Pull Request. Siehe macOS-Runner für iOS-CI.
Release-Builds und Signierung
Speichern Sie den Keystore als Secret, dekodieren Sie ihn beim Build in eine Datei und führen Sie flutter build appbundle aus. Committen Sie niemals Keystores. Laden Sie das Ergebnis als Artefakt hoch.
Monorepo mit melos
Führen Sie dart pub global activate melos und melos bootstrap aus und anschließend melos run test. Fügen Sie einen paths:-Filter hinzu, um nicht betroffene Pakete zu überspringen.
Integrationstests
Führen Sie flutter test integration_test auf einem Emulator mit reactivecircus/android-emulator-runner@v2 aus. Emulatoren sind langsam und profitieren von Test-Sharding.
Deployment
Fügen Sie einen Fastlane- oder Firebase-App-Distribution-Job nur auf main hinzu.
Auf schnelleren Maschinen ausführen
Ändern Sie eine Zeile in jedem Linux-Job:
runs-on: [self-hosted, Linux, compiler-ci]
Die Jobs laufen auf einer frischen Maschine mit 8 vCPUs von compiler.dev, mit automatischem Fallback auf Ihren ursprünglichen Runner. Android-Builds nutzen alle Kerne. Siehe Flutter auf GitHub Actions beschleunigen und Preise. macOS-Runner für iOS befinden sich bei compiler.dev in der Early Access.
FAQ
Muss ich den Pub-Cache cachen?
Bei kleinen Apps nicht. Fügen Sie ihn hinzu, wenn flutter pub get länger als etwa 30 Sekunden dauert.
Warum dauert der erste Lauf so lange?
Er lädt das Flutter SDK, Android-SDK-Komponenten und Gradle-Abhängigkeiten herunter. Spätere Läufe nutzen die Caches wieder.
Kann ich mehrere Flutter-Versionen testen?
Ja. Verwenden Sie einen Matrix-Build über flutter-version.
Soll analyze bei Warnungen fehlschlagen?
Verwenden Sie flutter analyze --fatal-infos für die strengste Einstellung oder den Standard, der bei Fehlern und Warnungen fehlschlägt.
Verwandt
- Flutter in GitHub Actions beschleunigenFlutter-CI in GitHub Actions beschleunigen: flutter-action, SDK- und Pub-Cache, parallele Tests und Android- und iOS-Builds auf getrennte Runner aufteilen.
- .NET GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für .NET mit NuGet-Cache, Restore-, Build- und Test-Schritten, optionalem SQL-Server-Dienst, Concurrency und Berechtigungen.
- Django GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für Django mit Postgres-Service-Container, pip-Caching, Migrationsprüfung und Tests sowie Concurrency und Berechtigungen.
- Docker Build GitHub Actions Workflow VorlageFertiger GitHub-Actions-Workflow zum Bauen von Docker-Images mit Buildx, GitHub-Cache-Layern und einem Push zu GHCR auf main, mit minimalen Berechtigungen.