https://github.com/jlengstorf/netlify-plugin-gatsby-cache
https://github.com/jlengstorf/netlify-plugin-gatsby-cache
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jlengstorf/netlify-plugin-gatsby-cache
- Owner: jlengstorf
- Archived: true
- Created: 2019-11-15T02:02:39.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2021-06-14T14:54:52.000Z (about 5 years ago)
- Last Synced: 2025-05-03T06:40:27.391Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 39.1 KB
- Stars: 185
- Watchers: 5
- Forks: 19
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - netlify-plugin-gatsby-cache
README
# Netlify Build Plugin: Persist the Gatsby Cache Between Builds
Persist the Gatsby cache between Netlify builds for huge build speed improvements! ⚡️
> **Note:** The functionality in this plugin is now available in the [Essential Gatsby build plugin](https://github.com/netlify/netlify-plugin-gatsby). Check out Essential Gatsby for additional framework-specific functionality on Netlify, including Gatsby Functions. If you choose to install it, you should remove this plugin first.
## Usage
Currently, there are **two ways to install this plugin on your application**:
### Installing from Netlify UI
#### [One-click install to add this to your Gatsby site](http://app.netlify.com/plugins/netlify-plugin-gatsby-cache/install?utm_source=github&utm_medium=gatsby-cache-bp-jl&utm_campaign=devex)
### Installing from your project's code
You can also install it manually using `netlify.toml`. If you want to know more about file-based configuration on Netlify, click [here](https://docs.netlify.com/configure-builds/file-based-configuration/).
Add the following lines to your project's `netlify.toml` file:
```toml
[build]
publish = "public"
[[plugins]]
package = "netlify-plugin-gatsby-cache"
```
> Note: The `[[plugins]]` line is required for each plugin, even if you have other plugins in your `netlify.toml` file already.
## How does it work?
This plugin determines the location of your `.cache` folder by looking at the `publish` folder configured for Netlify deployment. This means that if your Gatsby site successfully deploys, it will be cached as well with no config required! 🎉
## How much of a difference does this plugin make in build times?
Each Gatsby site is different, so build times vary widely between them, but one common slowdown in Gatsby builds is processing and transforming images. Gatsby is smart enough to check if these transformations have already been done and skip them, but in order to get that benefit in a build pipeline (e.g. Netlify) the `public` and `.cache` directories need to be preserved between builds. That’s what this plugin does!
| | No Cache | Cache | Savings |
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|---------|
| * 231 GraphQL queries
* 1,871 images
* 224 pages | 293207ms ([build log](https://app.netlify.com/sites/lengstorf/deploys/5dceed27d58a580008daaccc)) | 72835ms ([build log](https://app.netlify.com/sites/lengstorf/deploys/5dcef2463da4810008d48aaa)) | 75% |
| * 5 GraphQL queries
* No image processing
* 32 pages | 22072ms ([build log](https://app.netlify.com/sites/build-plugin-test/deploys/5dceed49e746a200091c76fe)) | 15543ms ([build log](https://app.netlify.com/sites/build-plugin-test/deploys/5dceedbfad95d0000bcd46d1)) | 30% |
tl;dr: Repeat builds with lots of images will be _much_ faster. With few or no images, the difference will be there, but it won’t be as pronounced.
## Want to learn how to create your own Netlify Build Plugins?
Check out [Sarah Drasner’s excellent tutorial](https://www.netlify.com/blog/2019/10/16/creating-and-using-your-first-netlify-build-plugin/?utm_source=github&utm_medium=netlify-plugin-gatsby-cache-jl&utm_campaign=devex)!