Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(gatsby): release plugin option validation #27437

Merged
merged 12 commits into from
Nov 2, 2020
Merged

feat(gatsby): release plugin option validation #27437

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fdd8ae6
chore(gatsby): add @gatsbyVersion pragma to pluginOptionsSchema Node API
mxstbr Oct 14, 2020
fae44f8
2.25.0!
mxstbr Oct 19, 2020
32ba7d3
Merge branch 'master' into plugin-options-schema-gatsby-version
mxstbr Oct 19, 2020
1aabfda
Merge branch 'master' into plugin-options-schema-gatsby-version
mxstbr Oct 27, 2020
69614e4
Remove GATSBY_EXPERIMENTAL_PLUGIN_OPTION_VALIDATION feature flag
mxstbr Oct 27, 2020
1c46c62
Fix incorrect option in gatsby-admin;
mxstbr Oct 27, 2020
2709129
Fix tests
mxstbr Oct 27, 2020
a68bd74
Remove obsolete snapshots
mxstbr Oct 27, 2020
75cd960
Merge branch 'master' into plugin-options-schema-gatsby-version
mxstbr Nov 2, 2020
d0e2d34
Trigger Build
mxstbr Nov 2, 2020
7392fb6
Remove flag from remark-autolink-headers
mxstbr Nov 2, 2020
1dde97d
Fix gatsby-plugin-mdx default
mxstbr Nov 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/gatsby/src/utils/api-node-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ export const onCreateDevServer = true

/**
* Called during `gatsby develop` bootstrap to get and validate a plugins options schema
* @gatsbyVersion 2.24.69
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, is the PR only that size? How is it working under the hood?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep! @DSchau implemented this way back in 2019 in #16105, I just didn't know! Soooo goooood 😍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, this is an incredible feature! Thanks for pointing the PR, will study on that 🚀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mxstbr what do you think of arbitrarily bumping the version of Gatsby here? (e.g. to 2.25.0 or something)

Seems better user behavior (cc @vladar useful to think about as a concrete example of release cadence being useful!)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I'm not quite following... How are users meant to upgrade to 2.25.0 if it doesn't exist yet? 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh -- I mean bump the version locally and then ship this 🚀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's bump that version after we land #27381 and set the minimum version to that!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this is going to need to be bumped to whatever version is the first to include the .default()s support from #27381 (which isn't merged yet).

* @param {Joi} $0.Joi The instance of Joi to define the schema with
*
*/
Expand Down