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.

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

Docs: Update the recommendation for the cadence of npm releases #35925

Merged
merged 1 commit into from
Oct 26, 2021

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Oct 25, 2021

Description

I'm proposing we change the moment when npm publishing is performed in relation to the Gutenberg plugin release. It's a recurring issue that we run into conflicts in the CHANGELOG files because new changes get added between the plugin's RC1 and the actual release. When we publish to npm a week after the plugin's RC1 we often see newer entries attributed to the previous npm release. A recent example would be #35886.

If we would start doing npm publishing just after the release branch is created for the Gutenberg plugin we would completely remove the chances to mess up with entries in the CHANGELOG files. All changes applied to CHANGELOG files at the time npm publishing would get cherry-picked before any new unreleased entries would get added from the in-progress PRs. In addition to that, the most important is the quality of the Gutenberg plugin and WordPress core so we can consider publishing to npm earlier as a another way to catch any integration issues early on.

@gziolo gziolo added [Type] Developer Documentation Documentation for developers npm Packages Related to npm packages labels Oct 25, 2021
@gziolo gziolo self-assigned this Oct 25, 2021
@gziolo gziolo requested a review from noisysocks October 25, 2021 14:05
Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

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

Changes LGTM and this seems like a great change to ensure that the release contains the correct changes.

@gziolo gziolo merged commit 2266ff8 into trunk Oct 26, 2021
@gziolo gziolo deleted the update/docs-npm-release branch October 26, 2021 08:13
@github-actions github-actions bot added this to the Gutenberg 11.9 milestone Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
npm Packages Related to npm packages [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants