React Native 向け GitHub Actions ワークフローテンプレート
最終更新
これは React Native アプリ向けに動作する .github/workflows/ci.yml です。高速な JavaScript ジョブが、push のたびに lint、型チェック、Jest を実行します。2つ目のジョブは Gradle キャッシュを使って Android アプリをビルドします。iOS は macOS が必要なため、バリエーションで扱います。
ワークフロー
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
分かりにくい部分の役割
- ジョブは意図的に2つに分けています。 JavaScript のチェックは数分で完了し、ほとんどのミスを検出します。Android ビルドは時間がかかるため、
needs: jsを指定して、これらのチェックの完了を待つようにしています。 cache: npmは、package-lock.jsonをキーとして npm のダウンロードをキャッシュします。npm のキャッシュを参照してください。Yarn や pnpm を使う場合は、キャッシュオプションとインストールコマンドを変更してください。Yarn と pnpm をご覧ください。--ci --maxWorkers=2を指定すると、Jest は古いスナップショットを書き込む代わりに失敗させます。また、ワーカー数を制限してメモリ使用量を予測しやすくします。より大きなマシンではmaxWorkersを増やしてください。- Gradle の前に
npm ciを実行します。 Android ビルドはnode_modulesからネイティブモジュールを読み込むため、先に JavaScript の依存関係をインストールしてください。 working-directory: androidは、gradlewファイルがある場所でラッパーを実行します。setup-gradleは、Gradle の依存関係とラッパーをキャッシュします。キャッシュが似た内容で大量に作られるのを避けるため、保存するのはmainのみです。詳細は Gradle のキャッシュをご覧ください。- デバッグビルド。
assembleDebugは署名鍵を必要としないため、プルリクエストでも安全に実行できます。
バリエーション
macOS 上での iOS ビルド
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
App をワークスペースとスキームに置き換えてください。macOS の実行時間は Linux の数倍のコストがかかるため、main 上、またはラベルを付けたプルリクエスト上で実行してください。iOS CI 向けの macOS ランナーと Xcode ビルドを高速化するをご覧ください。
ExpoとEAS
Expo プロジェクトでは、ここで npx expo-doctor と Jest を実行し、ネイティブビルドは EAS Build に任せてください。
エンドツーエンドテスト
Detox や Maestro にはエミュレーターが必要で、実行に時間がかかります。夜間に実行するか、シャーディングしてください。テストのシャーディングをご覧ください。
リリースビルド
ビルド時にシークレットから署名鍵をデコードし、APK または AAB を アーティファクトとしてアップロードします。
より高速なマシンで実行する
Android の Gradle ビルドはすべてのコアを使用し、最も時間のかかるステップです。各 Linux ジョブで次の1行を変更してください:
runs-on: [self-hosted, Linux, compiler-ci]
このジョブは compiler.dev の新しい 8 vCPU マシン上で実行され、元のランナーにフォールバックします。macOS は早期アクセス版です。GitHub Actions での React Native の高速化と 料金をご覧ください。
よくある質問
Watchman は必要ですか?
いいえ、CI での Jest には必要ありません。Jest が警告を出す場合は --watchman=false を使用してください。
初回の Android ビルドがこれほど遅いのはなぜですか?
Gradle が依存関係をダウンロードし、ネイティブコードをコンパイルするためです。2回目以降の実行はキャッシュによって高速化されます。
Linux で iOS をビルドできますか?
いいえ。iOS のビルドには macOS と Xcode が必要です。
CI で Metro のバンドルを実行すべきですか?
リリースビルドの場合のみです。チェックには、lint、型チェック、Jest で十分です。
関連記事
- GitHub ActionsでReact Nativeを高速化するGitHub Actionsで React Native のCIを高速化します。Gradle、CocoaPods、Metroのキャッシュ、Linux上でのJSチェック、macOSの利用時間を最小限に抑える方法を解説します。
- .NET GitHub Actions ワークフローテンプレートNuGet のキャッシュ、リストア、ビルド、テストの手順と SQL Server サービスの選択肢、同時実行制御と権限設定を備えた、.NET 向けの GitHub Actions CI をコピーしてすぐ使えます。
- Django GitHub Actions ワークフローテンプレートPostgres サービスコンテナー、pip キャッシュ、マイグレーションの確認とテストを備え、同時実行制御と権限設定も含む、Django 向けの GitHub Actions CI をコピーしてすぐ使えます。
- DockerビルドのGitHub ActionsワークフローテンプレートBuildx、GitHubのキャッシュレイヤー、mainへのプッシュ時のGHCRへのプッシュを使ってDockerイメージをビルドする、最小限の権限で動作するGitHub Actionsワークフローのコピー&ペースト用サンプルです。