コンテンツへスキップ

Flutter 用 GitHub Actions ワークフロー テンプレート

最終更新

これは Flutter アプリ用の動作する .github/workflows/ci.yml です。キャッシュを有効にして Flutter をインストールし、パッケージを解決したうえで flutter analyze と flutter test を実行します。2 つ目のジョブでは、デバッグ用の Android APK をビルドします。

ワークフロー

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

分かりにくい部分の役割

  • subosito/flutter-action@v2 は Flutter SDK をダウンロードします。cache: true は SDK 自体をキャッシュするため、以降の実行では大きなダウンロードが不要になります。pub パッケージはデフォルトではキャッシュされません。flutter pub get はランナー上の pub キャッシュを読み込むため、通常は十分に高速です。依存関係が多いプロジェクトでは、pubspec.lock をキーにした actions/cache ステップを追加して ~/.pub-cache をキャッシュしてください。
  • channel: stable は常に最新の安定版を使用します。ビルドの再現性を保つには、channel: stable と合わせて flutter-version: 3.x.x を固定してください(チームが開発で使用しているバージョンを指定します)。
  • 2 つのジョブ構成です。 解析とテストは短時間で完了し、早期にフィードバックを得られます。Android ビルドは処理が重いため、needs: test により完了を待ち、テストが失敗した場合は実行されません。needs を削除すると並列実行になり待ち時間は減りますが、コストは高くなります。
  • dart format ... --set-exit-if-changed は、フォーマットされていないファイルがある場合に失敗させます。変更内容は書き込まれません。
  • setup-gradle は、Android ビルドがダウンロードする Gradle ファイルをキャッシュします。詳しくは Gradle キャッシュ をご覧ください。
  • Java 17。 最近の Android Gradle プラグインには Java 17 以上が必要です。プロジェクトの要件に合わせてください。

バリエーション

iOS ビルド

macos-latest 上に flutter build ios --no-codesign を実行するジョブを追加します。macOS の実行時間は料金が高いため、プルリクエストごとではなく main でのみ実行してください。詳しくは iOS CI 向け macOS ランナー をご覧ください。

リリースビルドと署名

キーストアはシークレットとして保存し、ビルド時にファイルへデコードしたうえで flutter build appbundle を実行します。キーストアは決してコミットしないでください。結果は アーティファクト としてアップロードします。

melos を使ったモノレポ

dart pub global activate melos と melos bootstrap を実行したあと、melos run test を実行します。影響を受けないパッケージをスキップするには、paths: フィルターを追加してください。

インテグレーションテスト

reactivecircus/android-emulator-runner@v2 を使い、エミュレーター上で flutter test integration_test を実行します。エミュレーターは動作が遅いため、テストシャーディング を活用すると効果的です。

デプロイ

main でのみ実行される Fastlane または Firebase App Distribution のジョブを追加します。

より高速なマシンで実行する

Linux 上の各ジョブで 1 行を変更します:

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

ジョブは compiler.dev の新しい 8 vCPU マシン上で実行され、元のランナーへの自動フォールバックも備えています。Android ビルドではすべてのコアを利用します。詳しくは GitHub Actions で Flutter を高速化する と 料金 をご覧ください。iOS 向けの macOS ランナーは、compiler.dev で早期アクセス版を提供しています。

よくある質問

pub キャッシュは必要ですか?

小規模なアプリであれば必要ありません。flutter pub get の実行に約 30 秒以上かかる場合に追加してください。

初回の実行に時間がかかるのはなぜですか?

Flutter SDK、Android SDK のコンポーネント、Gradle の依存関係をダウンロードするためです。以降の実行ではキャッシュが再利用されます。

複数の Flutter バージョンでテストできますか?

はい。flutter-version に対して マトリックスビルド を使用できます。

analyze は警告で失敗させるべきですか?

最も厳格な設定にするには flutter analyze --fatal-infos を使用してください。デフォルトではエラーと警告で失敗します。