メインコンテンツまでスキップ

ローカルビルドでのBuild Cache for React Nativeの設定

Bitrise Build Cacheは、ローカルのReact Nativeビルドでも使用できます。ローカルビルドはCIビルドと同じキャッシュから読み取るため、CIがすでにコンパイルしたネイティブコードを、お使いのマシンで再度コンパイルする必要はありません。

React Nativeプロジェクトは3つのネイティブツールチェーンを通じてビルドされ、Bitrise Build Cache CLIはそのすべてをカバーします。AndroidにはGradle、iOSにはXcode、C++ネイティブモジュールにはccacheを使用します。それぞれがキャッシュする内容の概要については、Build Cache for React Nativeの概要を参照してください。

手動で手順を進める代わりに、AIコーディングエージェントを使ってセットアップすることもできます。AIの利用開始を参照してください。

開始する前にClick to copy link​

次の項目を確認してください。

  • iOS側にXcode 26 or laterを備えた、動作するReact Nativeプロジェクトがマシン上にあること。それより前のバージョンでは、CLIが必要とするコンパイルキャッシュのフラグが公開されておらず、ラッパーは何も行いません。
  • Build Cacheが有効なBitrise workspace。Build Cacheページで確認してください。
  • マシンがVPN、ファイアウォール、またはアウトバウンドプロキシの内側にある場合は、Build Cacheが使用するBitriseホストへのネットワークアクセス。ファイアウォールとVPN向けのネットワークエンドポイントを参照してください。

CLIとccacheのインストールClick to copy link​

brew install bitrise-io/bitrise-build-cache/bitrise-build-cache
brew install ccache

両方のインストール先がPATHに含まれていることを確認し、インストールを確認してください。

bitrise-build-cache --version
which ccache

キャッシュのアクティベートClick to copy link​

対話型ウィザードを実行します。

bitrise-build-cache activate --interactive

ウィザードでは次の項目が尋ねられます。

  1. Sign in to Bitrise: 初回実行時に、認証のためブラウザーが開きます。CLIは認証情報をOSキーチェーンに保存し、自動的に更新するため、以降の実行ではこの手順はスキップされます。
  2. Select a workspace: Build Cacheを使用するworkspaceを選択します。アクセスできるものが1つだけの場合は、CLIが自動的に選択します。
  3. Which build tools should I set up: Gradle、Xcode、ccache (C/C++) が選択されていることを確認します。スペースキーでオプションを切り替え、Enterキーで確定します。
  4. Cache for all projects, or only opted-in ones?: このマシンに複数のプロジェクトがあり、その一部だけでキャッシュを使用したい場合を除き、デフォルトの Always のままにします。プロジェクトごとのキャッシュスコープを参照してください。
  5. Display name for this machine's local invocations: Build Cacheダッシュボードにローカルビルドが表示される名前です。例: local-<yourhandle>。
  6. Enable cache push: デフォルトの Yes, push too のままにします。キャッシュプッシュモードを参照してください。
  7. Keep the cache proxies running in the background: Yes, install + start を選択します。これにより、ヘルパープロセスがOSに登録され、シェルを再起動しても動作し続けます。
Open a new terminal afterwards

Xcodeをアクティベートすると、シェルのrcファイルに1行が書き込まれ、PATHの先頭に~/.bitrise-xcelerate/binが追加されます。現在のシェルはまだこれを読み込んでいないため、そのシェルで開始したビルドはxcodebuildラッパーなしで実行され、doctorも警告しません。

新しいターミナルを開くか、source ~/.zshrcを実行してから、ラッパーが有効になっていることを確認します。

which xcodebuild
# → /Users/<you>/.bitrise-xcelerate/bin/xcodebuild

セットアップの確認Click to copy link​

CLIのヘルスチェックを実行します。

bitrise-build-cache doctor

認証情報、バックエンドへの接続、ヘルパープロセス、ログディレクトリなど、ローカルセットアップのすべての部分の状態が報告され、最後に全体の判定が表示されます。

Bitrise Build Cache - doctor
CLI version: 3.x.y

Healthy:
✓ auth OAuth login (keychain) (workspace <id>), token valid until <iso-timestamp>
✓ keychain-smoke Set/Get/Delete round-trip OK
✓ auth-backend latency <ms>, source=keychain, workspace=<id>
✓ project-scope mode=always; cache_push=true (machine config); no .bitrise-build-cache.json found in <cwd> or parents.; would gate this directory: no
✓ ccache-binary found at /opt/homebrew/bin/ccache
✓ xcelerate-proxy running (/var/folders/…/T/xcelerate-proxy.sock)
✓ xcelerate-enrichment no enrichment attempts yet
✓ ccache-helper running (~/.local/state/ccache/ccache.sock)
✓ log-dirs all log dirs present + writable

Overall: ok

最初のビルドの後、xcelerate-enrichmentはno enrichment attempts yetからhealthyに変わります。CLIが自動的に修復できる問題を修復するには、bitrise-build-cache doctor --fix --interactiveを実行してください。

Androidビルドの実行Click to copy link​

  1. ビルドがリモートキャッシュから取得するように、最初にプロジェクトのローカルビルド出力をクリーンアップします。アクティベーションの前に起動したGradleデーモンは新しい設定を読み込まないため、--no-daemonも指定してください。

    cd path/to/your/rn/project/android
    ./gradlew clean --no-daemon
  2. ビルドを実行します。

    cd ..
    bitrise-build-cache react-native run -- npx react-native build-android

ウォームキャッシュにヒットしたビルドは、次のように終了します。

> Task :app:compileDebugKotlin FROM-CACHE

BUILD SUCCESSFUL in 22s
149 actionable tasks: 71 executed, 78 from cache

[Bitrise Analytics] 155 tasks uploaded. Check invocation at
https://app.bitrise.io/build-cache/invocations/gradle/<uuid>

iOSビルドの実行Click to copy link​

CLIのラッパーコマンドを通じてビルドを実行します。

bitrise-build-cache react-native run -- npx react-native build-ios

宛先と構成を完全に制御したい場合は、xcodebuildを直接呼び出します。

xcodebuild \
-workspace ios/<yourproject>.xcworkspace \
-scheme <yourscheme> \
-configuration Debug \
-sdk iphonesimulator \
-destination 'generic/platform=iOS Simulator' \
CODE_SIGNING_ALLOWED=NO clean build

出力の最後に、ヒット数が0ではないCompilationCacheMetrics行と[Bitrise Analytics] Invocation savedリンクが表示されます。ネイティブモジュールはccacheを通じてコンパイルされ、その統計は同じ呼び出しに含まれます。

ラップするコマンドとその理由の詳細については、ネイティブビルドコマンドのラップを参照してください。

動作の確認Click to copy link​

シグナル確認場所成功時の状態
FROM-CACHEとY from cacheのサマリーAndroidのビルド出力0ではないfrom cache数
CompilationCacheMetrics N / M (P%)iOSのビルド出力0ではないヒット数
[Bitrise Analytics] Invocation savedビルド出力の最後の行呼び出しリンクが表示される
DashboardBuild Cacheページ表示名の下に、iOSビルドごとに1行、Androidビルドごとに1行
bitrise-build-cache doctorお使いのシェルxcelerate-proxy、xcelerate-enrichment、ccache-helperがすべて正常
Explicit module build warnings

ラッパーがSWIFT_ENABLE_EXPLICIT_MODULES=YESを設定していても、swift compiler caching requires explicit module buildの警告がいくつか表示されることがあります。Xcodeがラッパーのビルド設定が適用される前にこれらを出力するためであり、無視しても問題ありません。キャッシュヒット数から、キャッシュが機能していることを確認できます。

プロジェクトによっては、explicit modulesでまったくビルドできず、unable to resolve module dependencyで失敗することがあります。その場合は--no-swift-cacheでアクティベートしてください。clangとObjective-Cのコンパイルのみがキャッシュされ、Swiftはキャッシュされません。ウィザードではこの点は尋ねられないため、非対話型のアクティベートコマンドを使用します。

bitrise-build-cache activate react-native --no-swift-cache

キャッシュプッシュモードClick to copy link​

このガイドのセットアップでは、キャッシュプッシュを有効にしてBuild Cacheをアクティベートします。Android、iOS、ネイティブモジュールのビルドはすべて、共有キャッシュから読み取り、共有キャッシュに書き込みます。お使いのマシンがコンパイルしたものはすべて、チームメンバーやCIが再利用できるエントリになり、アクティビティはBuild Cacheページに表示されます。

ローカルビルドでキャッシュの読み取りのみを行いたい場合は、以下のプルのみモードの選択を参照してください。

プルのみモードの選択Click to copy link​

チームがすでにCIからキャッシュを蓄積していて、ローカルビルドでは読み取りのみを行いたい場合は、キャッシュプッシュをオフにします。トレードオフとして、ローカルビルドは何も提供しないため、CIがまだ実行されていないと、Androidビルドは0 from cacheを報告し続け、iOSビルドは0 / N (0%)。

ウィザードを再実行し、キャッシュプッシュのプロンプトで No, pull only と回答します。

bitrise-build-cache activate --interactive

これは3つのバックエンドすべてに一度に適用されるため、Android、iOS、ネイティブモジュールのビルドはキャッシュへの書き込みを停止します。

ビルドが期待どおりに動作しない場合は、デバッグログを有効にしてウィザードを再実行します。

bitrise-build-cache activate --interactive --debug

トラブルシューティングClick to copy link​

まずCLIのヘルスチェックから始めてください。ローカルセットアップのすべての部分を検査し、自動的に修復できる問題を修復します。

bitrise-build-cache doctor --fix --interactive

それでも問題が解決しない場合は、次の表を確認してください。

問題対処方法
ウィザードがターミナルが必要だと報告するTERM=dumb bitrise-build-cache activate --interactiveを実行して、行ベースモードを使用してください。
which xcodebuildが依然として/usr/bin/xcodebuildを指している新しいターミナルを開くか、source ~/.zshrcを実行してください。
iOSビルドにキャッシュのアクティビティがまったく表示されないラッパーを経由しないXcode.appからではなく、ターミナルから実行したことを確認してください。
Androidビルドが新しい設定を無視する実行中のGradleデーモンを./gradlew --stopで停止するか、--no-daemonを指定してください。
doctorが修復できない問題を報告する--debugを付けて再実行し、詳細なコンテキストを確認してください。
ビルドがキャッシュに到達できない、またはキャッシュ呼び出しがタイムアウトするVPN、ファイアウォール、またはプロキシがBitriseホストをブロックしている可能性があります。ファイアウォールとVPN向けのネットワークエンドポイントと照らして確認してください。