Zum Inhalt springen

React Native GitHub Actions Workflow-Vorlage

Zuletzt aktualisiert am

Dies ist eine funktionierende .github/workflows/ci.yml für eine React-Native-App. Ein schneller JavaScript-Job führt bei jedem Push Lint, Typprüfung und Jest aus. Ein zweiter Job baut die Android-App mit Gradle-Caching. iOS wird in den Varianten behandelt, da dafür macOS erforderlich ist.

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:
  js:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm

      - run: npm ci
      - run: npm run lint
      - run: npx tsc --noEmit
      - run: npm test -- --ci --maxWorkers=2

  android:
    needs: js
    runs-on: ubuntu-latest
    timeout-minutes: 40
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm

      - uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 17

      - uses: gradle/actions/setup-gradle@v4
        with:
          cache-read-only: ${{ github.ref != 'refs/heads/main' }}

      - run: npm ci
      - run: ./gradlew assembleDebug --no-daemon
        working-directory: android

Was die nicht offensichtlichen Teile bewirken

  • Bewusst zwei Jobs. Die JavaScript-Prüfungen sind in wenigen Minuten fertig und fangen die meisten Fehler ab. Der Android-Build dauert länger und wartet deshalb mit needs: js auf sie.
  • cache: npm cacht npm-Downloads anhand von package-lock.json. Siehe npm-Caching. Wenn Sie Yarn oder pnpm verwenden, passen Sie die Cache-Option und den Installationsbefehl an; siehe Yarn und pnpm.
  • --ci --maxWorkers=2 sorgt dafür, dass Jest bei veralteten Snapshots fehlschlägt, statt sie zu schreiben, und begrenzt die Worker, damit der Speicherverbrauch planbar bleibt. Auf größeren Maschinen können Sie maxWorkers erhöhen.
  • npm ci vor Gradle. Der Android-Build liest native Module aus node_modules, daher müssen die JavaScript-Abhängigkeiten zuerst installiert werden.
  • working-directory: android führt den Wrapper dort aus, wo sich die Datei gradlew befindet.
  • setup-gradle cacht Gradle-Abhängigkeiten und den Wrapper. Nur main speichert den Cache, um viele nahezu identische Einträge zu vermeiden. Details unter Gradle-Caching.
  • Debug-Build. assembleDebug benötigt keine Signierschlüssel und ist deshalb bei Pull Requests unbedenklich.

Varianten

iOS auf macOS

  ios:
    needs: js
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm
      - run: npm ci
      - run: bundle install && bundle exec pod install
        working-directory: ios
      - run: xcodebuild -workspace App.xcworkspace -scheme App -configuration Debug -sdk iphonesimulator build CODE_SIGNING_ALLOWED=NO
        working-directory: ios

Ersetzen Sie App durch Ihren Workspace und Scheme. macOS-Minuten kosten ein Vielfaches von Linux-Minuten. Führen Sie dies daher auf main oder auf gekennzeichneten Pull Requests aus. Siehe macOS-Runner für iOS-CI und Xcode-Builds beschleunigen.

Expo und EAS

Für Expo-Projekte führen Sie hier npx expo-doctor und Jest aus und überlassen die nativen Builds EAS Build.

End-to-End-Tests

Detox oder Maestro benötigen Emulatoren und sind langsam. Führen Sie sie nachts aus oder teilen Sie sie auf (Sharding); siehe Test-Sharding.

Release-Builds

Entschlüsseln Sie Signierschlüssel zur Build-Zeit aus Secrets und laden Sie die APK oder AAB als Artefakt hoch.

Auf schnelleren Maschinen ausführen

Android-Gradle-Builds nutzen alle Kerne und sind der längste Schritt. Ändern Sie auf jedem Linux-Job 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. macOS befindet sich in der Early-Access-Phase. Siehe React Native auf GitHub Actions beschleunigen und Preise.

FAQ

Brauche ich Watchman?

Nein, nicht für Jest in der CI. Verwenden Sie --watchman=false, falls Jest eine Warnung dazu ausgibt.

Warum dauert mein Android-Build beim ersten Mal so lange?

Gradle lädt Abhängigkeiten herunter und kompiliert nativen Code. Caches beschleunigen spätere Läufe.

Kann ich iOS unter Linux bauen?

Nein. iOS-Builds benötigen macOS und Xcode.

Sollte ich Metro-Bundling in der CI ausführen?

Nur für Release-Builds. Für Prüfungen reichen Lint, Typen und Jest aus.