Saltar al contenido

Plantilla de flujo de trabajo de GitHub Actions para Flutter

Última actualización

Este es un .github/workflows/ci.yml funcional para una aplicación Flutter. Instala Flutter con caché, resuelve los paquetes, ejecuta flutter analyze y flutter test, y compila un APK de depuración para Android en un segundo job.

El flujo de trabajo

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

Qué hacen las partes menos evidentes

  • subosito/flutter-action@v2 descarga el SDK de Flutter. cache: true guarda en caché el propio SDK, de modo que las ejecuciones posteriores omiten la gran descarga. Por defecto no guarda en caché los paquetes de pub; flutter pub get lee del caché de pub del runner, que suele ser rápido. Para árboles de dependencias pesados, añada un paso actions/cache para ~/.pub-cache con la clave basada en pubspec.lock.
  • channel: stable utiliza siempre la última versión estable. Para builds reproducibles, fije flutter-version: 3.x.x (use la versión con la que desarrolla su equipo) junto con channel: stable.
  • Dos jobs. El análisis y las pruebas son rápidos y ofrecen retroalimentación temprana. El build para Android es más pesado, así que espera con needs: test y no se ejecuta si fallan las pruebas. Elimine needs para ejecutarlos en paralelo, con menos espera pero a mayor coste.
  • dart format ... --set-exit-if-changed falla cuando los archivos no están formateados, sin escribir cambios.
  • setup-gradle guarda en caché los archivos de Gradle que descarga el build de Android. Consulte caché de Gradle.
  • Java 17. Los plugins recientes de Gradle para Android requieren al menos Java 17. Ajústelo a los requisitos de su proyecto.

Variantes

Builds para iOS

Añada un job en macos-latest con flutter build ios --no-codesign. Los minutos de macOS son costosos, así que ejecútelo solo en main, no en cada pull request. Consulte runners de macOS para CI de iOS.

Builds de release y firma

Guarde el keystore como secret, decodifíquelo en un archivo durante el build y ejecute flutter build appbundle. No suba nunca keystores al repositorio. Suba el resultado como artifact.

Monorepo con melos

Ejecute dart pub global activate melos y melos bootstrap, y después melos run test. Añada un filtro paths: para omitir los paquetes no afectados.

Pruebas de integración

Ejecute flutter test integration_test en un emulador con reactivecircus/android-emulator-runner@v2. Los emuladores son lentos y se benefician del sharding de pruebas.

Despliegue

Añada un job de Fastlane o Firebase App Distribution solo en main.

Ejecútelo en máquinas más rápidas

Cambie una línea en cada job de Linux:

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

Los jobs se ejecutan en una máquina nueva de 8 vCPU de compiler.dev, con recurso automático a su runner original. Los builds de Android utilizan todos los núcleos. Consulte cómo acelerar Flutter en GitHub Actions y precios. Los runners de macOS para iOS están en acceso anticipado en compiler.dev.

Preguntas frecuentes

¿Necesito guardar en caché el pub cache?

No en aplicaciones pequeñas. Añádalo si flutter pub get tarda más de unos 30 segundos.

¿Por qué la primera ejecución tarda tanto?

Descarga el SDK de Flutter, los componentes del SDK de Android y las dependencias de Gradle. Las ejecuciones posteriores reutilizan las cachés.

¿Puedo probar varias versiones de Flutter?

Sí. Use un build con matrix sobre flutter-version.

¿Debe fallar analyze con advertencias?

Use flutter analyze --fatal-infos para la configuración más estricta, o la predeterminada, que falla con errores y advertencias.