Skip to content

Commit 7c39c32

Browse files
piehkathmbeck
andauthored
chore(docs): Release Notes for 5.13 (#38759)
* initial 5.13 release notes * update links * remove link update todo * thanks-contributors * add headerRoutes usage in netlify adapter improvements list * add lmdb prebuilt binary preference for ssr/dsg * some wording updates, specifify source plugins and adapter versions * make action link relative * Apply suggestions from code review Co-authored-by: Katherine Beck <[email protected]> * set release date to Monday --------- Co-authored-by: Katherine Beck <[email protected]>
1 parent eed07f3 commit 7c39c32

File tree

1 file changed

+80
-0
lines changed
  • docs/docs/reference/release-notes/v5.13

1 file changed

+80
-0
lines changed
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
date: "2023-12-18"
3+
version: "5.13.0"
4+
title: "v5.13 Release Notes"
5+
---
6+
7+
Welcome to `[email protected]` release (December 2023 #1)
8+
9+
Key highlight of this release:
10+
11+
- [Custom Image and File CDN URL generators](#custom-image-and-file-cdn-url-generators)
12+
13+
Also check out [notable bugfixes](#notable-bugfixes--improvements).
14+
15+
**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).
16+
17+
[Previous release notes](/docs/reference/release-notes/v5.12)
18+
19+
[Full changelog][full-changelog]
20+
21+
---
22+
23+
## Custom Image and File CDN URL generators
24+
25+
[`[email protected]` introduced Image CDN](/docs/reference/release-notes/v4.10/#image-cdn) capability for Gatsby users. For best build performance, it requires a deployed site to handle image transformations at request time instead of at build time. Until now, handling those requests required supporting the specific URL format produced by Gatsby. With this release, we're introducing support for custom URL generators that allow you to use your own URL format. This makes it easier to integrate with existing site deployment platforms that offer Image CDN capabilities or to use self-managed Image CDNs by providing a way to generate URLs that are already in format expected by your CDN.
26+
27+
Adapter API now offers ability to provide custom URL generators modules for both Image CDN (`gatsbyImage`) and File CDN (`publicUrl`). `[email protected]` is optionally using this feature to make use of [Netlify's Image CDN](https://docs.netlify.com/image-cdn/overview/). Be sure to check [Netlify Adapter documentation](https://www.npmjs.com/package/gatsby-adapter-netlify#imagecdn) for more information on how to enable and configure it.
28+
29+
Image and File CDN now use remote URLs for source files. It is recommended to only allow certain remote URLs to be used to prevent abuse. This version also introduced a way for source plugins that support Image and File CDN to declare a list of allowed remote URLs with the newly added [`addRemoteFileAllowedUrl` action](/docs/reference/config-files/actions/#addRemoteFileAllowedUrl). Adapters will receive a list of allowed URLs to automatically configure or guide users on how to configure their deployment to allow those remote URLs.
30+
31+
The latest versions of Gatsby plugins - `gatsby-source-contentful` (`v8.13.0`), `gatsby-source-drupal` (`v6.13.0`), and `gatsby-source-wordpress` (`v7.13.0`) - now incorporate a new action to specify allowed remote URLs. Additionally, `gatsby-adapter-netlify` (`v1.1.0`) leverages this update to assist in configuring Netlify's Image CDN. It ensures these remote URLs are permitted and provides informative messages if your `netlify.toml` file requires adjustments to support these URLs.
32+
33+
If you are interested in using custom URL generators in your adapter, check the source code of `gatsby-adapter-netlify` for a reference implementation:
34+
35+
- [registering custom URL generators modules](https://github.com/gatsbyjs/gatsby/blob/4a780fbac717b1df337f156e2ac4b2da6478106b/packages/gatsby-adapter-netlify/src/index.ts#L159-L164)
36+
- [custom Image CDN URL generator](https://github.com/gatsbyjs/gatsby/blob/4a780fbac717b1df337f156e2ac4b2da6478106b/packages/gatsby-adapter-netlify/src/image-cdn-url-generator.ts)
37+
- [custom File CDN URL generator](https://github.com/gatsbyjs/gatsby/blob/4a780fbac717b1df337f156e2ac4b2da6478106b/packages/gatsby-adapter-netlify/src/file-cdn-url-generator.ts)
38+
39+
## Notable bugfixes & improvements
40+
41+
- `gatsby`:
42+
- Disable prettier formatting for autogenerated GraphQL Types, via [PR #38453](https://github.com/gatsbyjs/gatsby/pull/38453)
43+
- Fix API Functions compilation on Windows, via [PR #38489](https://github.com/gatsbyjs/gatsby/pull/38489)
44+
- Fix segmentation faults in DSG/SSR function when mounted in read-only directory, via [PR #38631](https://github.com/gatsbyjs/gatsby/pull/38631)
45+
- Detect when LMDB prebuilt binaries are not used and attempt to use prebuilt binaries in SSR/DSG engine to avoid runtime issues if functions environment is incompatible with binary built from source, via [PR #38691](https://github.com/gatsbyjs/gatsby/pull/38691)
46+
- Add `headerRoutes` to Adapters API to be able to use set of rules for setting headers instead of setting headers for each path individually, via [PR #38644](https://github.com/gatsbyjs/gatsby/pull/38644)
47+
- Handle Path Prefixed paths in Adapter's Route Manifest, via [PR #38666](https://github.com/gatsbyjs/gatsby/pull/38666)
48+
- `gatsby-adapter-netlify`:
49+
- Support Path Prefix and Trailing Slash options, via [PR #38666](https://github.com/gatsbyjs/gatsby/pull/38666)
50+
- Support `force` and `conditions` redirect parameters, via [PR #38657](https://github.com/gatsbyjs/gatsby/pull/38657)
51+
- Use `headerRoutes` if available to produce smaller `_headers` file, via [PR #38652](https://github.com/gatsbyjs/gatsby/pull/38652)
52+
- `gatsby-source-contentful`:
53+
- Properly configure sync options for incremental data update, via [PR #38468](https://github.com/gatsbyjs/gatsby/pull/38468)
54+
- Fix handling of "Long text" fields during incremental data updata, via [PR #38728](https://github.com/gatsbyjs/gatsby/pull/38728)
55+
- Multiple packages using `sharp` (image processing library):
56+
- Address security vulnerability in used version of `sharp` by upgrading, via [PR #38374](https://github.com/gatsbyjs/gatsby/pull/38374)
57+
58+
## Contributors
59+
60+
A big **Thank You** to [our community who contributed][full-changelog] to this release 💜
61+
62+
- [0o001](https://github.com/0o001): fix: GatsbyNodeAPI types [PR #38461](https://github.com/gatsbyjs/gatsby/pull/38461)
63+
- [CountryTk](https://github.com/CountryTk): feat(gatsby-plugin-google-tagmanager): add self hosted path option [PR #38731](https://github.com/gatsbyjs/gatsby/pull/38731)
64+
- [Hrishikesh-K](https://github.com/Hrishikesh-K): chore: added logging for cache handling [PR #38654](https://github.com/gatsbyjs/gatsby/pull/38654)
65+
- [axe312ger](https://github.com/axe312ger): fix: contentful delta updates [PR #38468](https://github.com/gatsbyjs/gatsby/pull/38468)
66+
- [cunhacf](https://github.com/cunhacf): fix(gatsby): support multiple instances of same variable in gatsbyImage placeholderUrl [PR #38626](https://github.com/gatsbyjs/gatsby/pull/38626)
67+
- [derrysucari](https://github.com/derrysucari): fix(gatsby): disable prettier for results of graphql typegen [PR #38453](https://github.com/gatsbyjs/gatsby/pull/38453)
68+
- [dhayab](https://github.com/dhayab): chore(docs): update algolia guide [PR #38458](https://github.com/gatsbyjs/gatsby/pull/38458)
69+
- [holtzy](https://github.com/holtzy): docs: Fix tiny typo (1 letter) [PR #38463](https://github.com/gatsbyjs/gatsby/pull/38463)
70+
- [joshuajames](https://github.com/joshuajames): chore(docs): update README.md [PR #38495](https://github.com/gatsbyjs/gatsby/pull/38495)
71+
- [jouni](https://github.com/jouni): docs: update `npm-cache` directory location [PR #38373](https://github.com/gatsbyjs/gatsby/pull/38373)
72+
- [kaltepeter](https://github.com/kaltepeter): chore(docs): fix broken eslint doc link in graphql-typegen docs [PR #38367](https://github.com/gatsbyjs/gatsby/pull/38367)
73+
- [laurenskling](https://github.com/laurenskling): docs: Update node-model.js to new sort syntax [PR #38515](https://github.com/gatsbyjs/gatsby/pull/38515)
74+
- [lovell](https://github.com/lovell): chore(deps): upgrade sharp to latest v0.32.6 [PR #38374](https://github.com/gatsbyjs/gatsby/pull/38374)
75+
- [palmiak](https://github.com/palmiak): docs: Changes the name of one of the service [PR #38650](https://github.com/gatsbyjs/gatsby/pull/38650)
76+
- [stephan1echung](https://github.com/stephan1echung)
77+
- Update gatsby-cloud-plugin README [PR #38479](https://github.com/gatsbyjs/gatsby/pull/38479)
78+
- Update gatsby-contentful-plugin README [PR #38480](https://github.com/gatsbyjs/gatsby/pull/38480)
79+
80+
[full-changelog]: https://github.com/gatsbyjs/gatsby/compare/[email protected]@5.13.0

0 commit comments

Comments
 (0)