継続的インテグレーション (CI) ビルドのキャッシュ

ビルドパフォーマンスを向上させるため、Next.jsはビルド間で共有される .next/cache にキャッシュを保存します。

継続的インテグレーション (CI) 環境でこのキャッシュを活用するには、CIワークフローをビルド間でキャッシュを正しく保持するように設定する必要があります。

CIが.next/cacheをビルド間で保持するように設定されていない場合、No Cache Detected エラーが表示される可能性があります。

一般的なCIプロバイダーのキャッシュ設定の例を以下に示します：

Vercel

Next.jsのキャッシュは自動的に設定されます。特に操作する必要はありません。Vercel上でTurborepoを使用している場合、詳細はこちらをご覧ください。

CircleCI

.circleci/config.ymlのsave_cacheステップを編集して、.next/cacheを含めます：

steps:
  - save_cache:
      key: dependency-cache-{{ checksum "yarn.lock" }}
      paths:
        - ./node_modules
        - ./.next/cache

save_cacheキーがない場合は、CircleCIのビルドキャッシュ設定に関するドキュメントに従ってください。

Travis CI

.travis.ymlに以下を追加または統合します：

cache:
  directories:
    - $HOME/.cache/yarn
    - node_modules
    - .next/cache

GitLab CI

.gitlab-ci.ymlに以下を追加または統合します：

cache:
  key: ${CI_COMMIT_REF_SLUG}
  paths:
    - node_modules/
    - .next/cache/

Netlify CI

Netlify Pluginsの@netlify/plugin-nextjsを使用します。

AWS CodeBuild

buildspec.ymlに以下を追加（またはマージ）します：

cache:
  paths:
    - 'node_modules/**/*' # より高速な`yarn`または`npm i`のために`node_modules`をキャッシュ
    - '.next/cache/**/*' # より高速なアプリケーションの再ビルドのためにNext.jsをキャッシュ

GitHub Actions

GitHub の actions/cache を使用して、ワークフローファイルに以下のステップを追加します：

uses: actions/cache@v4
with:
  # `yarn`でのキャッシングについてはここを参照 https://github.com/actions/cache/blob/main/examples.md#node---yarn または actions/setup-node でのキャッシングを活用 https://github.com/actions/setup-node
  path: |
    ~/.npm
    ${{ github.workspace }}/.next/cache
  # パッケージまたはソースファイルが変更されるたびに新しいキャッシュを生成。
  key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
  # ソースファイルが変更されてもパッケージが変更されていない場合、以前のキャッシュから再ビルド。
  restore-keys: |
    ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-

Bitbucket Pipelines

bitbucket-pipelines.ymlのトップレベル（pipelinesと同じレベル）に以下を追加または統合します：

definitions:
  caches:
    nextcache: .next/cache

次に、パイプラインのstepのcachesセクションでそれを参照します：

- step:
    name: your_step_name
    caches:
      - node
      - nextcache

Heroku

Herokuのカスタムキャッシュを使用して、トップレベルのpackage.jsonにcacheDirectories配列を追加します：

"cacheDirectories": [".next/cache"]

Azure Pipelines

Azure PipelinesのCacheタスクを使用して、next buildを実行するタスクの前のパイプラインyamlファイルに以下のタスクを追加します：

- task: Cache@2
  displayName: 'Cache .next/cache'
  inputs:
    key: next | $(Agent.OS) | yarn.lock
    path: '$(System.DefaultWorkingDirectory)/.next/cache'

Jenkins (Pipeline)

Jenkins の Job Cacher プラグインを使用して、通常next buildまたはnpm installを実行する場所のJenkinsfileに以下のビルドステップを追加します：

stage("Restore npm packages") {
    steps {
        // GITコミットハッシュに基づいてロックファイルをキャッシュに書き込み
        writeFile file: "next-lock.cache", text: "$GIT_COMMIT"
 
        cache(caches: [
            arbitraryFileCache(
                path: "node_modules",
                includes: "**/*",
                cacheValidityDecidingFile: "package-lock.json"
            )
        ]) {
            sh "npm install"
        }
    }
}
stage("Build") {
    steps {
        // GITコミットハッシュに基づいてロックファイルをキャッシュに書き込み
        writeFile file: "next-lock.cache", text: "$GIT_COMMIT"
 
        cache(caches: [
            arbitraryFileCache(
                path: ".next/cache",
                includes: "**/*",
                cacheValidityDecidingFile: "next-lock.cache"
            )
        ]) {
            // `next build`の略
            sh "npm run build"
        }
    }
}