GitHub Actions キャッシュキー生成ツール
パッケージマネージャーを選択すると、適切なパス、ロックファイルベースのキー、restore-keys によるフォールバックを含む actions/cache ステップが生成されます。インストールを高速に保ち、キャッシュが古くなることを防ぎます。
Workflow step
- uses: actions/cache@v4
with:
path: |
~/.npm
key: ${{ runner.os }}-npm-v1-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-npm-v1-
Exact key: ${{ runner.os }}-npm-v1-${{ hashFiles('**/package-lock.json') }}. Fallback prefix: ${{ runner.os }}-npm-v1-
すべての処理はお使いのブラウザー内で行われます。入力した内容が外部に送信されることはありません。
使い方
- パッケージマネージャーを選択してください。キャッシュパスとロックファイルのパターンが自動で入力されます。
- キーに OS と CPU アーキテクチャを含めるかどうかを決め、キャッシュを無効化するためのバージョンソルトを追加してください。
- インストールステップの前に、YAML をワークフローにコピーしてください。
よくある質問
良いキャッシュキーとは何ですか?
OS、ツール、ソルトを識別するプレフィックスと、ロックファイルのハッシュを組み合わせたものです。ロックファイルが変わるとキーも変わるため、新しいキャッシュが作成されます。
restore-keys は何のためにありますか?
完全一致するキャッシュがない場合、GitHub は restore key で始まるキーを持つ最新のキャッシュを復元します。これにより、インストールでは変更された部分のみを取得すれば済みます。
問題のあるキャッシュを無効化するにはどうすればよいですか?
キーのバージョンソルトを変更します(例:v1 から v2 へ)。古いエントリは、7 日間使用されないと期限切れになります。
キャッシュのサイズにはどの程度の上限がありますか?
リポジトリのキャッシュ容量は既定で合計 10 GB です。容量がいっぱいになると、最後に使用された時期が最も古いエントリから削除されます。
関連ガイド
- GitHub Actions で Cargo と Rust のビルドをキャッシュするSwatinem/rust-cache または actions/cache を使用して、GitHub Actions で Cargo レジストリ、git 依存関係、target ディレクトリをキャッシュします。キャッシュが肥大化しないように注意します。
- GitHub Actions で Go モジュールとビルドキャッシュをキャッシュするsetup-go または actions/cache を使用して、GitHub Actions で Go モジュール(GOMODCACHE)とビルドキャッシュ(GOCACHE)をキャッシュします。キー、go.sum、キャッシュヒットの確認方法を解説します。
- GitHub Actions で Gradle ビルドをキャッシュするgradle/actions/setup-gradle または actions/cache を使用して、GitHub Actions で Gradle の依存関係とビルドキャッシュをキャッシュします。キー、プルリクエストでの読み取り専用設定、クリーンアップ、確認方法を解説します。
- GitHub Actions で npm の依存関係をキャッシュするsetup-node または actions/cache を使用して、GitHub Actions で npm の依存関係をキャッシュします。動作する YAML、適切なキー、node_modules をキャッシュしない理由、キャッシュヒットの確認方法を解説します。
この計算ツールをサイトに埋め込む
ブログやドキュメントへの埋め込みは無料です。表示させたい場所に次の HTML を貼り付けてください:
<iframe src="https://compiler.dev/embed/actions-cache-key-builder" title="GitHub Actions cache key builder" width="100%" height="560" style="border:1px solid #e5e7eb;border-radius:12px" loading="lazy"></iframe>
<p style="font-size:12px">Calculator by <a href="https://compiler.dev/tools/actions-cache-key-builder">compiler.dev</a></p>関連ツール
- GitHub Actions ワークフロー YAML チェッカーGitHub Actions のワークフローを貼り付けると、runs-on の指定漏れ、固定されていないアクション、pull_request_target のリスク、permissions の未設定、不正な needs を検出します。
- CI 分数予測ツール1 日あたりのプルリクエスト数、PR ごとのプッシュ数、実行ごとのジョブ数、ジョブごとの分数から、月間の CI 分数と GitHub Actions の料金を予測します。プランとランナーを考慮します。
- テストシャーディング・プランナーテストの実行時間を貼り付けると、バランスの取れたシャードに分割できます。各シャードのテスト内容、想定される実行時間、高速化の度合いを、CI を変更する前に確認できます。
- Dependabot 設定ジェネレーターnpm、pip、Docker、GitHub Actions、Go、Cargo などの dependabot.yml を、スケジュール、グループ化、ラベル、レビュアーを含めて生成します。検証済みで、そのままコピーして使えます。