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

非Bitrise CI環境でのBuild Cache for React Nativeの設定

Bitrise Build Cache CLIは、サードパーティのCIプロバイダー(GitHub Actions、GitLab CI、CircleCI、Jenkinsなど)にダウンロードして実行できます。

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

GitHub Actionsを使用する場合

GitHub Actionsのワークフロー例を掲載した専用ガイドがあります。GitHub ActionsでのBuild Cache for React Nativeの設定を参照してください。

Bitrise Build Hubのランナーでは、トークンはまったく必要ありません。マシンはすでにBitrise Workspaceに接続されているため、CLIが自動的に認証されます。以下の手順は、それ以外のすべての環境が対象です。

トークンの選択Click to copy link​

CI の連携には、workspace API トークンを使用してください。このトークンは個人ではなくworkspaceに属するため、担当者のロールが変わったり退社したりしても、ビルドは引き続き動作します。

Personal Access Tokenも使用できますが、作成したユーザーのロールを引き継ぎ、そのユーザーがworkspaceを離れると動作しなくなります。

ご自身のマシンでは、どちらも必要ありません。CLIがブラウザー経由でサインインし、認証情報をOSキーチェーンに保存します。お使いのビルドツール向けのローカルガイドについては、ローカル開発環境でのセットアップを参照してください。

キャッシュの設定Click to copy link​

  1. 少なくともviewerworkspaceロールを持つworkspace APIトークンを作成します。

  2. Workspaceのスラッグを取得します。

  3. CIプロバイダーのシークレット/環境設定で、2つの変数を設定します。

    • BITRISE_BUILD_CACHE_AUTH_TOKEN: workspace APIトークン。
    • BITRISE_BUILD_CACHE_WORKSPACE_ID: workspaceのスラッグ。
  4. ビルドを実行するStepの前に、CIパイプラインへ次のスクリプトを追加します。

    このスクリプトは、高速化の対象となるビルドコマンドと同じ環境(同じシェル、同じコンテナー)で実行する必要があります。

    #!/usr/bin/env bash
    set -euxo pipefail

    # Download the Bitrise Build Cache CLI.
    curl --retry 5 -sSfL \
    'https://raw.githubusercontent.com/bitrise-io/bitrise-build-cache-cli/main/install/installer.sh' \
    | sh -s -- -b /tmp/bin -d

    # Activate Build Cache for React Native (Gradle + Xcode + ccache for C++).
    /tmp/bin/bitrise-build-cache activate react-native

    デフォルトでは、3つのバックエンドすべてが有効になります。バックエンドを無効にするには、対応するフラグを渡します。

    /tmp/bin/bitrise-build-cache activate react-native --gradle=true --xcode=true --cpp=false

    CIは通常、キャッシュにデータを書き込む環境です。読み取りに加えて書き込みアクセスも有効にするには、--cache-pushを渡します。

    /tmp/bin/bitrise-build-cache activate react-native --cache-push
    注記

    これまでBitrise Build Cache CLIをGradleまたはXcodeのみに使用していた場合は、React Nativeのサポートを利用するために、CLI v1.0.0以降を使用していることを確認してください。

  5. 有効化後、bitrise-build-cacheバイナリがPATHに追加されます。ビルドを実行するコマンドの先頭にbitrise-build-cache react-native runを付けてください。

    注記

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

Exampleの設定: GitHub Actions

Bitrise Build Hubランナーで実行するジョブを含むGitHub Actionsのワークフロー例については、GitHub ActionsでのBuild Cache for React Nativeの設定を参照してください。

セットアップの検証Click to copy link​

  1. 新しい設定でビルドを実行します。アクティベーションステップが正常に完了するはずです。
  2. BitriseのBuild detailsページを開き、Build Cacheタブを確認します。ラップされたコマンドがキャッシュ統計とともに一覧表示されます。
  3. 最初のビルドでは、キャッシュヒット率が0%と報告されます。この時点ではキャッシュが空のため、これは想定どおりの動作です。
  4. キャッシュを温めるために、さらに1~3回ビルドを実行します。以降のビルドでは、ヒット率が0%を超えるはずです。
  5. ビルドごと、およびビルド全体のキャッシュパフォーマンスは、Build Cache一覧ページで確認できます。