|
16 | 16 | - support gatsby base dirs outside the site root |
17 | 17 | ([#281](https://github.com/netlify/netlify-plugin-gatsby/issues/281)) |
18 | 18 | ([ccbec68](https://github.com/netlify/netlify-plugin-gatsby/commit/ccbec681bfce40598ca2a91945f29ee35b04603c)) |
| 19 | + |
| 20 | +## [2.0.0](https://github.com/netlify/netlify-plugin-gatsby/compare/v2.0.0-zz-beta.0...v2.0.0) (2022-01-31) |
| 21 | + |
| 22 | +Version 2 of the Essential Gatsby build plugin adds support for the new render |
| 23 | +modes introduced in Gatsby 4, as well as improved support for Gatsby functions. |
| 24 | +For best results it should be installed alongside |
| 25 | +[`gatsby-plugin-netlify`](https://github.com/netlify/gatsby-plugin-netlify/). |
| 26 | +Beta support was available since Gatsby 4 was released, but with this stable |
| 27 | +release it is ready for production use for everyone. |
| 28 | + |
| 29 | +### Features |
| 30 | + |
| 31 | +This version adds full support for the new Gatsby 4 render modes on Netlify. |
| 32 | +Gatsby 4 introduced two render modes, alongside its original SSG mode. For a |
| 33 | +detailed comparison of each mode |
| 34 | +[see this blog post](https://www.netlify.com/blog/2021/09/16/run-gatsby-4-with-dsg-and-ssr-on-netlify-today/). |
| 35 | + |
| 36 | +To support these new modes, the Essential Netlify build plugin generates three |
| 37 | +serverless Netlify Functions that are automatically deployed alongside your |
| 38 | +site: |
| 39 | + |
| 40 | +- `__api`: used for Gatsby Functions |
| 41 | +- `__dsg`: an |
| 42 | + [on-demand builder](https://docs.netlify.com/configure-builds/on-demand-builders/) |
| 43 | + used for DSG pages. |
| 44 | +- `__ssr`: used for server-side rendered pages. |
| 45 | + |
| 46 | +You do not need to configure or deploy these functions yourself: they are |
| 47 | +automatically generated and deployed whenever you build. |
| 48 | + |
| 49 | +You can see the logs for these functions in the "Functions" tabs in the Netlify |
| 50 | +dashboard. |
| 51 | + |
| 52 | +It will also generate Netlify rewrites to ensure that each route is handled by |
| 53 | +the correct function. |
| 54 | + |
| 55 | +### Installing |
| 56 | + |
| 57 | +This version of the plugin will soon be installed automatically for all Gatsby |
| 58 | +sites on Netlify. If you can't wait, you can |
| 59 | +[install it manually](https://github.com/netlify/netlify-plugin-gatsby#installation) |
| 60 | +using file-based plugin installation. |
| 61 | + |
| 62 | +You should also install `gatsby-plugin-netlify` to enable all features. **It is |
| 63 | +required if you are using SSR pages**. See |
| 64 | +[how to install](https://github.com/netlify/netlify-plugin-gatsby#install-the-gatsby-plugin) |
| 65 | + |
| 66 | +### Deploying your site |
| 67 | + |
| 68 | +You do not need to do anything different to deploy your site if building on |
| 69 | +Netlify: it will automatically deploy the functions when you build. If you are |
| 70 | +deploying manually using the Netlify CLI, you must ensure that instead of |
| 71 | +running `netlify build` then `netlify deploy` as separate commands, you run them |
| 72 | +together as `netlify deploy --build`. |
| 73 | + |
| 74 | +### Caveats |
| 75 | + |
| 76 | +Currently you cannot use `StaticImage` or `gatsby-transformer-sharp` in SSR or |
| 77 | +DSG pages. The best workaround is to use an image CDN such as |
| 78 | +[Cloudinary](https://www.gatsbyjs.com/docs/how-to/images-and-media/using-cloudinary-image-service/) |
| 79 | +or [imgix](https://github.com/imgix/gatsby) to host your images. This will give |
| 80 | +you faster builds too. |
| 81 | + |
| 82 | +### Feedback |
| 83 | + |
| 84 | +If you have feedback or bug reports, join |
| 85 | +[the discussion](https://github.com/netlify/netlify-plugin-gatsby/discussions) |
| 86 | +or [open an issue](https://github.com/netlify/netlify-plugin-gatsby/issues) |
0 commit comments