4d3cca3382
* Warn on No Cache in CI * Bold the note lead * Add custom clarification for netlify * Reorder * Add tests * Fix detection
76 lines
2.1 KiB
Markdown
76 lines
2.1 KiB
Markdown
# No Cache Detected
|
|
|
|
#### Why This Error Occurred
|
|
|
|
A Next.js build was triggered in a continuous integration environment, but no cache was detected.
|
|
|
|
This results in slower builds and can hurt Next.js' persistent caching of client-side bundles across builds.
|
|
|
|
#### Possible Ways to Fix It
|
|
|
|
> **Note**: If this is a new project, or being built for the first time in your CI, you can ignore this error.
|
|
> However, you'll want to make sure it doesn't continue to happen and fix it if it does!
|
|
|
|
Configure Next.js' cache to be persisted across builds. Next.js stores its cache in the `.next/cache` directory.
|
|
|
|
Storing this folder across builds varies by CI provider. We've provided a list of a few common providers below.
|
|
|
|
**ZEIT Now**
|
|
|
|
Next.js caching is automatically configured for you. There's no action required on your part.
|
|
|
|
**CircleCI**
|
|
|
|
Edit your `save_cache` step in `.circleci/config.yml` to include `.next/cache`:
|
|
|
|
```yaml
|
|
steps:
|
|
- save_cache:
|
|
key: dependency-cache-{{ checksum "yarn.lock" }}
|
|
paths:
|
|
- ./node_modules
|
|
- ./.next/cache
|
|
```
|
|
|
|
If you do not have a `save_cache` key, please follow CircleCI's [documentation on setting up build caching](https://circleci.com/docs/2.0/caching/).
|
|
|
|
**Travis CI**
|
|
|
|
Add or merge the following into your `.travis.yml`:
|
|
|
|
```yaml
|
|
cache:
|
|
directories:
|
|
- $HOME/.cache/yarn
|
|
- node_modules
|
|
- .next/cache
|
|
```
|
|
|
|
**GitLab CI**
|
|
|
|
Add or merge the following into your `.gitlab-ci.yml`:
|
|
|
|
```yaml
|
|
cache:
|
|
key: ${CI_COMMIT_REF_SLUG}
|
|
paths:
|
|
- node_modules/
|
|
- .next/cache/
|
|
```
|
|
|
|
**Netlify CI**
|
|
|
|
It is **not possible** to cache custom build files on Netlify. Please contact their support and request they support this behavior.
|
|
|
|
You can investigate using a 3rd party solution (e.g. [`cache-me-outside`](https://github.com/DavidWells/cache-me-outside)) to manually cache the Next.js output.
|
|
|
|
**AWS CodeBuild**
|
|
|
|
Add (or merge in) the following to your `buildspec.yml`:
|
|
|
|
```yaml
|
|
cache:
|
|
paths:
|
|
- 'node_modules/**/*' # Cache `node_modules` for faster `yarn` or `npm i`
|
|
- '.next/cache/**/*' # Cache Next.js for faster application rebuilds
|
|
```
|