コンテンツへスキップ

リモートビルドキャッシュとは?

最終更新

リモートビルドキャッシュとは、各タスクの入力のハッシュをキーとして、ビルドおよびテストの出力を保存する共有ストアです。CI上でも開発者のノートPCでも、同じ入力で同じタスクが必要になったマシンは、タスクを再実行する代わりに保存済みの結果をダウンロードします。

仕組み

Nx、Turborepo、Gradle、Bazelなどのビルドツールは、作業をタスク(コンパイル、リント、テスト、バンドル)に分割します。各タスクについて、ツールはソースファイル、依存関係、環境変数、コマンドからハッシュを計算します。実行前にキャッシュへそのハッシュを問い合わせます。ヒットした場合は出力ファイルを復元し、ログを再生します。ミスした場合はタスクを実行し、結果をアップロードします。

これは依存関係キャッシュよりも細かい粒度で動作します。actions/cacheのエントリは、ジョブ全体のフォルダを1つ復元します。リモートキャッシュは個々のタスクをスキップするため、モノレポ内の1つのパッケージを変更しても、再ビルドされるのはそのパッケージとその依存先だけです。

ハッシュがすべての入力を対象とするため、正しさは入力を適切に宣言できるかどうかに左右されます。宣言されていないファイルを読み込むタスクは、古い出力を返す可能性があります。

例

認証情報に環境変数を使用する、リモートキャッシュ付きのTurborepoの設定例:

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm
      - run: npm ci
      - run: npx turbo run build test lint

Nxも独自のキャッシュ設定で同様に動作します。NxとTurborepo向けのモノレポCIガイドをご覧ください。compiler.devは、マシンローカルの依存関係、git、Dockerレイヤーのキャッシュに加えて、NxとTurborepoのリモートキャッシュに対応しています。詳細は料金のページをご覧ください。

リモートキャッシュとローカルキャッシュの違い

  • ローカルキャッシュは1台のマシンのディスク上に保存されます。無料ですが、新しいCIランナーは毎回空の状態から始まります。
  • リモートキャッシュはランナーや開発者の間で共有されるため、一時的に作られるCI環境でも役立ちます。

よくある間違い

  • 宣言されていない入力。出力に影響するものの、ハッシュに含まれていない環境変数やファイルは、誤ったキャッシュヒットを引き起こします。
  • 非決定的な出力。ビルド出力にタイムスタンプやランダムなIDが含まれていると、実行のたびに結果が異なって見えます。
  • ネットワークに接続するテストのキャッシュ。キャッシュされた成功結果は、失敗している依存関係を隠してしまいます。
  • フォークからのプルリクエストによる書き込み。キャッシュポイズニングは現実的なリスクです。信頼されていないコードには読み取り専用のアクセスを与えてください。
  • 依存関係キャッシュの代替として扱うこと。依存関係のインストールを素早く行う仕組みは引き続き必要です。GitHub Actionsのキャッシュをご覧ください。

よくある質問

リモートビルドキャッシュは安全ですか?

デプロイ先と同様に扱ってください。書き込み権限は信頼されたブランチに限定し、トークンはシークレットに保管してください。

Dockerビルドでも使用できますか?

Dockerには独自のレイヤーキャッシュがあります。CIでのDockerレイヤーキャッシュをご覧ください。

どのくらい時間を節約できますか?

実行ごとにタスクが変更されない頻度によって異なります。変更が小さいモノレポで最も効果が得られます。