GitHub ActionsでFlutterを高速化する
最終更新
GitHub ActionsでFlutterを高速化するには、subosito/flutter-actionでFlutter SDKとpubパッケージをキャッシュし、分析とテストはLinuxで実行し、AndroidのビルドもLinuxで行い、macOSはiOSのビルドのみに使用してください。macOSの分単位の料金はLinuxの数倍となり、Flutterのパイプラインの大部分はMacを必要としません。
このガイドは、GitHub Actionsを高速化する一般的なガイドのFlutter版です。
時間がかかっている箇所
Flutterのパイプラインは4つの部分で構成されます。SDKのインストール、flutter pub get、flutter analyzeとflutter test、そしてプラットフォームごとのビルド(flutter build apkまたはappbundle、flutter build ios)です。新しいVMではSDKのダウンロードだけで数百メガバイトになり、ネイティブビルド(AndroidのGradle、iOSのXcodeとCocoaPods)が最も時間のかかる処理です。テストと分析のステップは比較的短時間で完了します。
flutter-actionによるSDKとpubキャッシュ
subosito/flutter-actionはFlutterをインストールし、そのキャッシュも行えます。READMEには次の入力項目が記載されています。
channel:stable、beta、masterのいずれか。flutter-version:3.19.0のようなバージョン、または3.xのような部分的な指定。flutter-version-file:pubspec.yamlまたは.fvmrcからバージョンを読み取ります。READMEでは、ファイルには正確なバージョンが記載されている必要があり、範囲指定は機能しないと注意されています。cache: Flutter SDKをキャッシュします。pub-cacheが未設定の場合は、pubの依存関係のキャッシュも制御します。cache-key、pub-cache-key、cache-path: カスタムのキーとパスです。:os:、:channel:、:version:、:arch:、:hash:などのプレースホルダーを使用できます。
- uses: actions/checkout@v7
- uses: subosito/flutter-action@v2
with:
channel: stable
flutter-version-file: pubspec.yaml
cache: true
- run: flutter pub get
- run: flutter analyze
- run: flutter test --coverage
stableを無条件に追従するのではなく、(ファイルまたはflutter-versionで)バージョンを固定してください。新しい安定版がリリースされるとSDKのキャッシュキーが変わり、ビルドの内容も変化してしまいます。バージョンを固定すると、キャッシュのヒット率も予測しやすくなります。
テストの速度
flutter testはテストファイルを並列に実行します。--concurrencyオプションを使用し、デフォルトではコア数から少し減らした値になるため、コア数が多いほど自動的に高速化されます。実践的なヒントは次のとおりです。
- 高速なウィジェットテストやユニットテスト(
flutter test)と、デバイスやエミュレーターを必要とし起動に時間のかかる統合テスト(integration_test/)を分けてください。 - カバレッジをアップロードする場合にのみ
flutter test --coverageを使用してください。時間が余計にかかります。 - リポジトリに複数のパッケージがある場合(Melosを使ったモノレポ)は、マトリクスでパッケージごとに
flutter testを実行するか、Melosでスクリプトを並列実行してください。 - ゴールデンテストは、1つのOS上で生成と比較を行ってください。フォントはプラットフォームごとに異なり、Linuxは実行コストが最も低い環境です。
LinuxでのAndroidビルド
AndroidのビルドはGradleを実行するため、Gradle用のキャッシュ設定が必要です。設定方法についてはGradleのガイドを参照しながら、actions/setup-javaとgradle/actions/setup-gradleを追加してください。
build-android:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v7
- uses: actions/setup-java@v6
with:
distribution: temurin
java-version: 17
- uses: gradle/actions/setup-gradle@v6
- uses: subosito/flutter-action@v2
with:
channel: stable
flutter-version-file: pubspec.yaml
cache: true
- run: flutter pub get
- run: flutter build apk --release
- uses: actions/upload-artifact@v7
with:
name: apk
path: build/app/outputs/flutter-apk/app-release.apk
個別のAPKが必要な場合にのみflutter build apk --split-per-abiを使用してください。ABIごとにビルドするため時間がかかります。ストアへのアップロードには、アプリバンドル(appbundle)を一度ビルドしてください。Javaのバージョンを固定する前に、使用しているAndroid Gradle Pluginのバージョンが必要とするJavaのバージョンを確認してください。
macOSでのiOSビルドは必要最小限に
flutter build iosにはXcodeが必要なため、macOSが必要です。このジョブは別に分け、必要なときだけ実行してください。たとえばすべてのPRのpushではなく、mainやタグのときだけ実行します。CocoaPodsはios/Podfile.lockをキーにしてios/Podsをキャッシュすると効率的です。
build-ios:
runs-on: macos-latest
steps:
- uses: actions/checkout@v7
- uses: subosito/flutter-action@v2
with:
channel: stable
flutter-version-file: pubspec.yaml
cache: true
- uses: actions/cache@v6
with:
path: ios/Pods
key: pods-${{ runner.os }}-${{ hashFiles('ios/Podfile.lock') }}
- run: flutter pub get
- run: flutter build ios --release --no-codesign
コンパイルの確認だけであれば--no-codesignが適しています。実際の署名はリリースのジョブでのみ行ってください。macOSのコストやオプションについては、iOS CI向けのmacOSランナーとCIでのXcodeビルドの高速化を参照してください。ホスト型のmacOSは、Linuxよりも高い分単位の料金が請求されるため、Linuxに移した分だけ確実にコストを削減できます。
効果的なジョブ構成
- すべてのpushで、Linux上で
analyze-testを実行します(pub get、分析、テスト)。 android/またはlib/を変更するPRのpushごとに、Linux上でbuild-androidを実行します。mainとタグの場合のみ、macOS上でbuild-iosを実行します。
パスフィルターとconcurrencyを使用して、置き換えられた古い実行をキャンセルしてください。
CPU コア数を増やす効果
Flutterのテストは並列に実行され、GradleもいくつかのコアをCPUとして利用するため、大きなLinuxマシンは分析、テスト、Androidビルドに効果があります。Xcodeのステップは、Linuxのコアの恩恵をまったく受けません。Flutterの行はベンチマークにないため、高速化率は示しません。compiler.devの標準のLinuxマシンは8 vCPU / 16 GBで、料金は1分あたり$0.008です。macOSは早期アクセス中で、Apple M4 Pro 7コアのVMが1分あたり$0.028、14コアのVMが1分あたり$0.055です。料金とランナーの料金を参照してください。切り替えは1行で済みます: runs-on: [self-hosted, Linux, compiler-ci]
関連ページ: Flutterテンプレート、React Nativeのガイド、GitHub Actionsのキャッシュ
よくある質問
flutter-actionはpubキャッシュも行いますか?
はい。cache: trueを指定するとSDKをキャッシュし、pub-cacheを個別に設定しない限りpubの依存関係もキャッシュします。カスタムのキーはpub-cache-keyで設定できます。
LinuxでiOSアプリをビルドできますか?
いいえ。iOSのビルドにはmacOS上のXcodeが必要です。AndroidのビルドとテストはLinuxで実行してください。
Flutterのバージョンは固定すべきですか?
はい。flutter-versionまたはflutter-version-fileを使用すると、SDKとキャッシュキーは、ご自身が決めたときにのみ変わります。
Flutterの統合テストを速く実行するには?
別のジョブで実行し、アプリが対応している場合はLinuxデスクトップデバイスのようなヘッドレスなターゲットを使用してください。遅い場合はmainでのみ実行してください。
関連記事
- GitHub ActionsでTypeScriptモノレポを高速化するGitHub Actionsで TypeScriptモノレポの型チェックとリンターを高速化する: インクリメンタルtsc、プロジェクト参照、Lintキャッシュ、並列ジョブ
- GitHub ActionsでモノレポのPlaywrightを高速化するGitHub Actions で Node モノレポの Playwright E2E テストを高速化: アプリを一度だけビルドし、Web アプリに変更がないときは E2E をスキップし、シャーディングとレポートのマージを行います。
- READMEにCIの速度バッジを追加するREADME のバッジで CI の速さを表示しましょう。リポジトリの GitHub Actions 実行時間の中央値が自動で更新されます。公開リポジトリは無料です。
- GitHub Actionsで.NETを高速化するGitHub Actions で .NET のビルドを高速化する: setup-dotnet による NuGet キャッシュ、--no-restore、--no-build、並列の dotnet test、SQL Server サービス。