From 07f444959a32c66a5ae8a05332c5c8d6c5fe768a Mon Sep 17 00:00:00 2001 From: Vladimir Razuvaev Date: Mon, 12 Apr 2021 18:27:39 +0700 Subject: [PATCH 1/6] chore(docs): 3.3 release notes --- .../reference/release-notes/v3.3/index.md | 117 ++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 docs/docs/reference/release-notes/v3.3/index.md diff --git a/docs/docs/reference/release-notes/v3.3/index.md b/docs/docs/reference/release-notes/v3.3/index.md new file mode 100644 index 0000000000000..91fe62dc8051e --- /dev/null +++ b/docs/docs/reference/release-notes/v3.3/index.md @@ -0,0 +1,117 @@ +--- +date: "2021-04-13" +version: "3.3.0" +--- + +# [v3.3](https://github.com/gatsbyjs/gatsby/compare/gatsby@3.3.0...gatsby@3.3.0) (April 2021 #1) + +Welcome to `gatsby@3.3.0` release (April 2021 #1) + +Key highlights of this release: + +- [Performance optimizations](#performance-optimizations) - faster JS bundling, lower peak memory usage +- [Upgrade to the latest `sharp`](#upgrade-to-the-latest-sharp) - built-in image optimizations; and now works on M1 Macs +- [Upgrade to the latest `remark`](#upgrade-to-the-latest-remark) - more consistency in Markdown rendering + +Also check out [notable bugfixes](#notable-bugfixes--improvements). + +**Bleeding Edge:** Want to try new features as soon as possible? Install `gatsby@next` and let us know +if you have any [issues](https://github.com/gatsbyjs/gatsby/issues). + +[Previous release notes](/docs/reference/release-notes/v3.1) + +[Full changelog](https://github.com/gatsbyjs/gatsby/compare/gatsby@3.3.0...gatsby@3.3.0) + +--- + +## Performance optimizations + +### Faster JS bundling + +This release adds memoization of babel loader options. It significantly reduces the overhead in JS compilation step. +With our sample site we saw a speed-up in JS bundling up to 30-40% + +Note: this improvement only affects JS bundling, so if you use other heavy transformations (CSS-in-JS, Mdx, etc), +you will likely see modest improvements. + +[Original PR](https://github.com/gatsbyjs/gatsby/pull/28738/) + +### Lower peak memory usage + +This release restricts concurrency of html-file generation which greatly reduces memory and disk pressure +and decreases spikes in memory usage. With our example site we saw a decrease in peak memory usage from +~3.5 GB to ~1.7 GB (without negative effects to build time). + +[Original PR](https://github.com/gatsbyjs/gatsby/pull/30793) + +## Upgrade to the latest `remark` + +Remark has had a significant [major upgrade](https://github.com/remarkjs/remark/releases/tag/13.0.0) +recently (version 13) and changed the underlying parser. The ecosystem has almost [caught up](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) +since then, so we've decided to release new major versions of all our `remark` plugins. + +The following plugins are now fully compatible with `remark@13`: + +- **gatsby-transformer-remark@4.0.0** +- gatsby-remark-autolink-headers@4.0.0 +- gatsby-remark-code-repls@5.0.0 +- gatsby-remark-copy-linked-files@4.0.0 +- gatsby-remark-embed-snippet@6.0.0 +- gatsby-remark-graphviz@3.0.0 +- gatsby-remark-images-contentful@4.0.0 +- gatsby-remark-images@5.0.0 +- gatsby-remark-katex@5.0.0 +- gatsby-remark-prismjs@5.0.0 +- gatsby-remark-responsive-iframe@4.0.0 +- gatsby-remark-smartypants@4.0.0 + +We've tried to make the migration effortless and non-breaking (just update the dependencies) +but there are subtle differences in HTML output caused by the new remark parser. +We've identified and listed the most common differences [in this discussion](https://github.com/gatsbyjs/gatsby/discussions/30385) +(if you spot other notable changes - please comment there!) + +Also check out [remark changelog](https://github.com/remarkjs/remark/releases/tag/13.0.0), specifically the section: "Changes to output / the tree". + +### Incompatible plugin: gatsby-remark-custom-blocks + +The only plugin provided by Gatsby that is not compatible yet with `remark@13` is +[`gatsby-remark-custom-blocks`](https://www.gatsbyjs.com/plugins/gatsby-remark-custom-blocks/). +This plugin relies on the upstream remark plugin `remark-custom-blocks` which is itself not compatible with +`remark@13` yet. + +The work on updating it is [in progress](https://github.com/zestedesavoir/zmarkdown/issues/416) +though, and as soon as it is finished we will publish the new major version for our plugin as well. + +In the meantime if you use this plugin you can just wait when it's ready or modify your markdown +and switch to another syntax. Remark authors [suggest](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) +using [`remark-directive`](https://github.com/remarkjs/remark-directive) as an alternative. +Unfortunately there is no Gatsby plugin for it yet. But if you decide to build one - please let us +know in the [umbrella discussion](https://github.com/gatsbyjs/gatsby/discussions/30385) and we'll link it here. + +- [Umbrella discussion](https://github.com/gatsbyjs/gatsby/discussions/30385) +- [Original PR](https://github.com/gatsbyjs/gatsby/pull/29678) + +--- + +## Upgrade to the latest `sharp` + +Check out [Sharp changelog](https://github.com/lovell/sharp/blob/ed5d753b89e5649b1586de04ffef6ec903942a64/docs/changelog.md#v028---bijou) +for a full list of changes. + +The most important highlights of the new release: + +- Smaller install size +- Supports Mac M1: now uses prebuilt libvips binaries for M1 Macs +- Includes buil-in image optimization (unlocks future perf improvements in Gatsby) + +[Original PR](https://github.com/gatsbyjs/gatsby/pull/30541) + +## Notable bugfixes & improvements + +- Fixed invalid query results in cached builds [PR #30594](https://github.com/gatsbyjs/gatsby/pull/30594) +- Schema customization: merge fields of interfaces defined by multiple plugins [PR #30501](https://github.com/gatsbyjs/gatsby/pull/30501) +- Fix for IE11: add dom collections to polyfills [PR #30483](https://github.com/gatsbyjs/gatsby/pull/30483) + +## Contributors + +TODO after backporting all fixes From 96499cdd70471ddf4cfa21927051adcc6211ca9f Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Tue, 13 Apr 2021 01:16:00 -0700 Subject: [PATCH 2/6] fix(release notes): Add qualifier to peak memory claim (#30845) Co-authored-by: Lennart --- docs/docs/reference/release-notes/v3.3/index.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/docs/reference/release-notes/v3.3/index.md b/docs/docs/reference/release-notes/v3.3/index.md index 91fe62dc8051e..708f85e936752 100644 --- a/docs/docs/reference/release-notes/v3.3/index.md +++ b/docs/docs/reference/release-notes/v3.3/index.md @@ -38,9 +38,8 @@ you will likely see modest improvements. ### Lower peak memory usage -This release restricts concurrency of html-file generation which greatly reduces memory and disk pressure -and decreases spikes in memory usage. With our example site we saw a decrease in peak memory usage from -~3.5 GB to ~1.7 GB (without negative effects to build time). +This release restricts concurrency of html-file generation which can greatly reduce memory and disk pressure +and decrease spikes in memory usage — especially for sites with many 100s+ pages and large page-data.json files. With our example site we saw a decrease in peak memory usage from ~3.5 GB to ~1.7 GB (without negative effects to build time). [Original PR](https://github.com/gatsbyjs/gatsby/pull/30793) From 7b17eae9afa1815304c6b9557499a46e9d8bb0f2 Mon Sep 17 00:00:00 2001 From: Vladimir Razuvaev Date: Tue, 13 Apr 2021 17:33:06 +0700 Subject: [PATCH 3/6] add a note about to-gatsby-remark-plugin --- docs/docs/reference/release-notes/v3.3/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/reference/release-notes/v3.3/index.md b/docs/docs/reference/release-notes/v3.3/index.md index 708f85e936752..62617e689d1c6 100644 --- a/docs/docs/reference/release-notes/v3.3/index.md +++ b/docs/docs/reference/release-notes/v3.3/index.md @@ -84,8 +84,7 @@ though, and as soon as it is finished we will publish the new major version for In the meantime if you use this plugin you can just wait when it's ready or modify your markdown and switch to another syntax. Remark authors [suggest](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) using [`remark-directive`](https://github.com/remarkjs/remark-directive) as an alternative. -Unfortunately there is no Gatsby plugin for it yet. But if you decide to build one - please let us -know in the [umbrella discussion](https://github.com/gatsbyjs/gatsby/discussions/30385) and we'll link it here. +Use [`to-gatsby-remark-plugin`](https://www.npmjs.com/package/to-gatsby-remark-plugin) package to convert it to Gatsby remark plugin. - [Umbrella discussion](https://github.com/gatsbyjs/gatsby/discussions/30385) - [Original PR](https://github.com/gatsbyjs/gatsby/pull/29678) From a45082b08697033132bd116885530b52735c5051 Mon Sep 17 00:00:00 2001 From: Vladimir Razuvaev Date: Wed, 14 Apr 2021 01:35:07 +0700 Subject: [PATCH 4/6] fix typo --- docs/docs/reference/release-notes/v3.3/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/reference/release-notes/v3.3/index.md b/docs/docs/reference/release-notes/v3.3/index.md index 62617e689d1c6..295a59b520cca 100644 --- a/docs/docs/reference/release-notes/v3.3/index.md +++ b/docs/docs/reference/release-notes/v3.3/index.md @@ -18,7 +18,7 @@ Also check out [notable bugfixes](#notable-bugfixes--improvements). **Bleeding Edge:** Want to try new features as soon as possible? Install `gatsby@next` and let us know if you have any [issues](https://github.com/gatsbyjs/gatsby/issues). -[Previous release notes](/docs/reference/release-notes/v3.1) +[Previous release notes](/docs/reference/release-notes/v3.2) [Full changelog](https://github.com/gatsbyjs/gatsby/compare/gatsby@3.3.0...gatsby@3.3.0) From 157b59228dfda1818896e2d4e51613160f80734f Mon Sep 17 00:00:00 2001 From: Vladimir Razuvaev Date: Wed, 14 Apr 2021 01:37:47 +0700 Subject: [PATCH 5/6] add notes about gatsby-plugin-image --- docs/docs/reference/release-notes/v3.3/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/docs/reference/release-notes/v3.3/index.md b/docs/docs/reference/release-notes/v3.3/index.md index 295a59b520cca..43f821990df58 100644 --- a/docs/docs/reference/release-notes/v3.3/index.md +++ b/docs/docs/reference/release-notes/v3.3/index.md @@ -12,6 +12,7 @@ Key highlights of this release: - [Performance optimizations](#performance-optimizations) - faster JS bundling, lower peak memory usage - [Upgrade to the latest `sharp`](#upgrade-to-the-latest-sharp) - built-in image optimizations; and now works on M1 Macs - [Upgrade to the latest `remark`](#upgrade-to-the-latest-remark) - more consistency in Markdown rendering +- [Bugfixes in `gatsby-plugin-image`](#bugfixes-in-gatsby-plugin-image130) Also check out [notable bugfixes](#notable-bugfixes--improvements). @@ -104,6 +105,14 @@ The most important highlights of the new release: [Original PR](https://github.com/gatsbyjs/gatsby/pull/30541) +## Bugfixes in `gatsby-plugin-image@1.3.0` + +- Fix a bug that caused errors in third party packages that access the `global` object +- Fix a bug that prevented `draggable="false"` being set on the `GatsbyImage` component +- Fix a bug that caused blurred previews to be generated at the wrong aspect ratio +- Fix a bug that prevented lazy-loaded images displaying in Safari +- Fix a bug that caused duplicate type errors when using Contentful images with other plugins that implement images + ## Notable bugfixes & improvements - Fixed invalid query results in cached builds [PR #30594](https://github.com/gatsbyjs/gatsby/pull/30594) From b44d8cffe6728592ed8f401f6fd86ab64ddf58cd Mon Sep 17 00:00:00 2001 From: Vladimir Razuvaev Date: Wed, 14 Apr 2021 02:28:05 +0700 Subject: [PATCH 6/6] add contributors --- .../reference/release-notes/v3.3/index.md | 30 +++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/docs/reference/release-notes/v3.3/index.md b/docs/docs/reference/release-notes/v3.3/index.md index 43f821990df58..b189c2ebb6208 100644 --- a/docs/docs/reference/release-notes/v3.3/index.md +++ b/docs/docs/reference/release-notes/v3.3/index.md @@ -21,7 +21,7 @@ if you have any [issues](https://github.com/gatsbyjs/gatsby/issues). [Previous release notes](/docs/reference/release-notes/v3.2) -[Full changelog](https://github.com/gatsbyjs/gatsby/compare/gatsby@3.3.0...gatsby@3.3.0) +[Full changelog](https://github.com/gatsbyjs/gatsby/compare/gatsby@3.3.0-next.0...gatsby@3.3.0) --- @@ -121,4 +121,30 @@ The most important highlights of the new release: ## Contributors -TODO after backporting all fixes +A big **Thank You** to [our community who contributed](https://github.com/gatsbyjs/gatsby/compare/gatsby@3.3.0-next.0...gatsby@3.3.0) to this release 💜 + +- [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) +- [axe312ger](https://github.com/axe312ger) + + - fix(gatsby-source-contentful): Improve network error handling [PR #30257](https://github.com/gatsbyjs/gatsby/pull/30257) + - chore(contentful): create compiled files in dist instead of . [PR #30414](https://github.com/gatsbyjs/gatsby/pull/30414) + - fix(examples): Update using-contentful to use gatsby-plugin-image [PR #29526](https://github.com/gatsbyjs/gatsby/pull/29526) + - build(using-contentful): add missing sharp dependency [PR #30546](https://github.com/gatsbyjs/gatsby/pull/30546) + - feat(gatsby-source-contentful): Increase Contentful sync by up to 10x [PR #30422](https://github.com/gatsbyjs/gatsby/pull/30422) + - fix(contentful): set proper defaults for gatsby-plugin-image [PR #30536](https://github.com/gatsbyjs/gatsby/pull/30536) + - feat(gatsby-source-contentful): update docs and improve errors [PR #30538](https://github.com/gatsbyjs/gatsby/pull/30538) + - fix(gatsby-source-contentful): Contentful page limit backoff [PR #30549](https://github.com/gatsbyjs/gatsby/pull/30549) + - fix(contentful): ensure fragments are properly distributed [PR #30555](https://github.com/gatsbyjs/gatsby/pull/30555) + - fix(using-contentful): clean up dependencies [PR #30556](https://github.com/gatsbyjs/gatsby/pull/30556) + - fix(contentful): make gatsby-plugin-image a peer dependency [PR #30709](https://github.com/gatsbyjs/gatsby/pull/30709) + +- [ridem](https://github.com/ridem): fix(gatsby-plugin-netlify-cms): Don't use StaticQueryMapper [PR #30599](https://github.com/gatsbyjs/gatsby/pull/30599) +- [Nurou](https://github.com/Nurou): chore(gatsby-source-wordpress): Link to source WP plugin [PR #30645](https://github.com/gatsbyjs/gatsby/pull/30645) +- [baker-jr-john](https://github.com/baker-jr-john): chore(docs): Update how-gatsby-works-with-github-pages [PR #30630](https://github.com/gatsbyjs/gatsby/pull/30630) +- [cametumbling](https://github.com/cametumbling) + + - chore(docs): Add link to part 8 tutorial [PR #30604](https://github.com/gatsbyjs/gatsby/pull/30604) + - chore(docs): Update wording of tutorial part 8 [PR #30606](https://github.com/gatsbyjs/gatsby/pull/30606) + +- [nategiraudeau](https://github.com/nategiraudeau): fix(gatsby-example-using-remark) fix broken example for typescript users [PR #30505](https://github.com/gatsbyjs/gatsby/pull/30505) +- [AntonNiklasson](https://github.com/AntonNiklasson): chore(docs): include autoprefixer in tailwind install command [PR #30718](https://github.com/gatsbyjs/gatsby/pull/30718)