Skip to content

Commit ecd4e4e

Browse files
LekoArtsvladar
andauthored
docs: Release Notes for 3.2 (#30462)
* initial * updates * added notes on contentful and upcoming remark upgrade * Re-arrange release notes a bit * update contributors after backporting Co-authored-by: Vladimir Razuvaev <[email protected]>
1 parent a55ffeb commit ecd4e4e

File tree

1 file changed

+126
-0
lines changed
  • docs/docs/reference/release-notes/v3.2

1 file changed

+126
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
date: "2021-03-30"
3+
version: "3.2.0"
4+
---
5+
6+
# [v3.2](https://github.com/gatsbyjs/gatsby/compare/[email protected]@3.2.0) (March 2021 #3)
7+
8+
Welcome to `[email protected]` release (March 2021 #3)
9+
10+
Key highlights of this release:
11+
12+
- [Better `StaticImage` errors](#better-staticimage-errors)
13+
- [Adjustable ES Modules option for CSS Modules](#adjustable-es-modules-option-for-css-modules)
14+
- [`gatsby-source-contentful`](#gatsby-source-contentful520) - improved performance and other changes
15+
16+
Also check out [notable bugfixes](#notable-bugfixes).
17+
18+
Sneak peek to next releases:
19+
20+
- [Major bump of all remark plugins](#next-version-major-bump-of-all-remark-plugins)
21+
22+
**Bleeding Edge:** Want to try new features as soon as possible? Install `gatsby@next` and let us know
23+
if you have any [issues](https://github.com/gatsbyjs/gatsby/issues).
24+
25+
[Previous release notes](/docs/reference/release-notes/v3.1)
26+
27+
[Full changelog](https://github.com/gatsbyjs/gatsby/compare/[email protected]@3.2.0)
28+
29+
## Better `StaticImage` errors
30+
31+
For our new `gatsby-plugin-image` we also introduced `StaticImage` to allow quick usage of the image pipeline for images that are the same every time. But it comes [with some restrictions](/docs/reference/built-in-components/gatsby-plugin-image/#restrictions-on-using-staticimage) that you need to think of.
32+
33+
To make using `StaticImage` easier the previous error message was adjusted to now also show the offending code and link to the relevant documentation.
34+
35+
![CLI showing an error with a description, a codeframe with the relevant code, and link to documentation](https://user-images.githubusercontent.com/213306/111302367-3a142500-864b-11eb-8768-d46e452e70f1.png)
36+
37+
**Bonus:** If you want to use `StaticImage` as a background image, read our [newly added docs](/docs/how-to/images-and-media/using-gatsby-plugin-image#background-images).
38+
39+
## Adjustable ES Modules option for CSS Modules
40+
41+
With the release of Gatsby v3 we made the choice to [import CSS modules as ES Modules](/docs/reference/release-notes/migrating-from-v2-to-v3/#css-modules-are-imported-as-es-modules) by default. This allows better treeshaking and smaller files as a result -- however, when using third-party packages that still expect CommonJS you'll need to work around this behavior to be able to migrate to Gatsby v3.
42+
43+
Together with v3.2 also new minors of `gatsby-plugin-sass`, `gatsby-plugin-less`, `gatsby-plugin-postcss`, and `gatsby-plugin-stylus` were released. You're now able to override the [`esModule`](https://github.com/webpack-contrib/css-loader#esmodule) and [`namedExport`](https://github.com/webpack-contrib/css-loader#namedexport) option of [`css-loader`](https://github.com/webpack-contrib/css-loader) inside each plugin.
44+
45+
Please see the [migration guide](/docs/reference/release-notes/migrating-from-v2-to-v3/#css-modules-are-imported-as-es-modules) for an example.
46+
47+
48+
49+
Features:
50+
51+
- The default limit when fetching data from Contentful was increased by 10 times. This will speed up build times.
52+
- The [`using-contentful`](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-contentful) example got updated to Gatsby v3 and demonstrates how to use [`gatsby-plugin-image`](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-image) with Contenful.
53+
- New e2e-contentful test suite to improve plugin reliabliity.
54+
55+
Fixes:
56+
57+
- Network errors are properly retried again.
58+
- Set proper defaults when for `gatsby-plugin-image` (Constrained layout with dominant color as placeholder)
59+
- Improved help when connection credentials are wrong
60+
- Improved the docs and added more details about the `downloadLocal` config option
61+
62+
---
63+
64+
## Notable bugfixes & improvements
65+
66+
- Be less aggressive about the [`fs` in SSR usage](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/#using-fs-in-ssr) warnings, now excluding `http(s).Agent` and `node-gyp-build` [PR #30216](https://github.com/gatsbyjs/gatsby/pull/30216)
67+
- Fixing rendering issues in `gatsby-plugin-image` with the placeholder and component itself [PR #30221](https://github.com/gatsbyjs/gatsby/pull/30221)
68+
- Documentation about [Debugging Incremental Builds](/docs/debugging-incremental-builds/) [PR #30329](https://github.com/gatsbyjs/gatsby/pull/30329)
69+
- Validate plugin options schema also for local plugins [PR #29787](https://github.com/gatsbyjs/gatsby/pull/29787)
70+
71+
---
72+
73+
## Next version: major bump of all remark plugins
74+
75+
Remark has had a significant [major upgrade](https://github.com/remarkjs/remark/releases/tag/13.0.0) recently and changed the underlying parser. The ecosystem seems to have almost [caught up](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) since then, so we are going to release a new major version for all remark-related plugins soon.
76+
77+
We tried to make the upgrade effortless but there could still be subtle differences in output and edge cases. So please try pre-release versions of those plugins and [let us know](https://github.com/gatsbyjs/gatsby/discussions/30385) if you notice any inconsistencies or bugs.
78+
79+
Install the following canary versions of all remark packages that you have in your `package.json`:
80+
81+
```
82+
gatsby-remark-autolink-headers@alpha-remark13
83+
gatsby-remark-code-repls@alpha-remark13
84+
gatsby-remark-copy-linked-files@alpha-remark13
85+
gatsby-remark-custom-blocks@alpha-remark13
86+
gatsby-remark-embed-snippet@alpha-remark13
87+
gatsby-remark-graphviz@alpha-remark13
88+
gatsby-remark-images-contentful@alpha-remark13
89+
gatsby-remark-images@alpha-remark13
90+
gatsby-remark-katex@alpha-remark13
91+
gatsby-remark-prismjs@alpha-remark13
92+
gatsby-remark-responsive-iframe@alpha-remark13
93+
gatsby-remark-smartypants@alpha-remark13
94+
gatsby-transformer-remark@alpha-remark13
95+
```
96+
97+
[Umbrella discussion](https://github.com/gatsbyjs/gatsby/discussions/30385)
98+
99+
## Contributors
100+
101+
A big **Thank You** to [our community who contributed](https://github.com/gatsbyjs/gatsby/compare/[email protected]@3.2.0) to this release 💜
102+
103+
- [misfist](https://github.com/misfist): chore(starters): Update WordPress blog README [PR #30209](https://github.com/gatsbyjs/gatsby/pull/30209)
104+
- [TngSam](https://github.com/TngSam): chore(docs): Update using-web-fonts [PR #30243](https://github.com/gatsbyjs/gatsby/pull/30243)
105+
- [andrewrota](https://github.com/andrewrota): chore(docs): Fix link to markdown-syntax [PR #30239](https://github.com/gatsbyjs/gatsby/pull/30239)
106+
- [dhrumilp15](https://github.com/dhrumilp15)
107+
- chore(dosc): Update deploying-to-digitalocean-droplet [PR #30205](https://github.com/gatsbyjs/gatsby/pull/30205)
108+
- chore(docs): Update deploying-to-digitalocean-droplet [PR #30266](https://github.com/gatsbyjs/gatsby/pull/30266)
109+
- [pedrolamas](https://github.com/pedrolamas): fix(gatsby-plugin-netlify): upgrade webpack-assets-manifest for compatibility with webpack@5 [PR #30217](https://github.com/gatsbyjs/gatsby/pull/30217)
110+
- [Elendev](https://github.com/Elendev): chore(docs): Fix typo in createPages doc [PR #30343](https://github.com/gatsbyjs/gatsby/pull/30343)
111+
- [blenderskool](https://github.com/blenderskool): fix(gatsby): Add reporter.panic in empty catch in load-themes [PR #29640](https://github.com/gatsbyjs/gatsby/pull/29640)
112+
- [UgRoss](https://github.com/UgRoss): fix(gatsby): Fix wrong resolve id for CommentJson type [PR #30389](https://github.com/gatsbyjs/gatsby/pull/30389)
113+
- [larowlan](https://github.com/larowlan): fix(drupal): Support forward revisions for Drupal paragraphs [PR #29289](https://github.com/gatsbyjs/gatsby/pull/29289)
114+
- [kamranayub](https://github.com/kamranayub): fix(gatsby): validate local plugin options schema [PR #29787](https://github.com/gatsbyjs/gatsby/pull/29787)
115+
- [JobenM](https://github.com/JobenM): fix(gatsby-plugin-mdx): timeToRead returns NaN when word count is 0 [PR #30489](https://github.com/gatsbyjs/gatsby/pull/30489)
116+
- [axe312ger](https://github.com/axe312ger)
117+
- fix(gatsby-source-contentful): Improve network error handling [PR #30257](https://github.com/gatsbyjs/gatsby/pull/30257)
118+
- chore(contentful): create compiled files in dist instead of . [PR #30414](https://github.com/gatsbyjs/gatsby/pull/30414)
119+
- fix(examples): Update using-contentful to use gatsby-plugin-image [PR #29526](https://github.com/gatsbyjs/gatsby/pull/29526)
120+
- build(using-contentful): add missing sharp dependency [PR #30546](https://github.com/gatsbyjs/gatsby/pull/30546)
121+
- feat(gatsby-source-contentful): Increase Contentful sync by up to 10x [PR #30422](https://github.com/gatsbyjs/gatsby/pull/30422)
122+
- fix(contentful): set proper defaults for gatsby-plugin-image [PR #30536](https://github.com/gatsbyjs/gatsby/pull/30536)
123+
- feat(gatsby-source-contentful): update docs and improve errors [PR #30538](https://github.com/gatsbyjs/gatsby/pull/30538)
124+
- fix(gatsby-source-contentful): Contentful page limit backoff [PR #30549](https://github.com/gatsbyjs/gatsby/pull/30549)
125+
- fix(contentful): ensure fragments are properly distributed [PR #30555](https://github.com/gatsbyjs/gatsby/pull/30555)
126+
- fix(using-contentful): clean up dependencies [PR #30556](https://github.com/gatsbyjs/gatsby/pull/30556)

0 commit comments

Comments
 (0)