Clarifying the npm package release process for the RC release. #46555
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryanwelcher
added
Developer Experience
ryanwelcher
requested review from
ajitbohra,
juanmaguitar and
fabiankaegy
as code owners
priethor
added
[Type] Developer Documentation
dmsnell
pushed a commit
that referenced
this pull request
Dec 15, 2022
talldan
reviewed
Jan 24, 2023
| @@ -34,6 +34,10 @@ To release a release candidate (RC) version of the plugin, enter `rc`. To releas | |||
|
|
|||
| This will trigger a GitHub Actions (GHA) workflow that bumps the plugin version, builds the Gutenberg plugin .zip file, creates a release draft, and attaches the plugin .zip file to it. This part of the process typically takes a little under six minutes. You'll see that workflow appear at the top of the list, right under the blue banner. Once it's finished, it'll change its status icon from a yellow dot to a green checkmark. You can follow along in a more detailed view by clicking on the workflow. | |||
|
|
|||
| #### Publishing the @wordpress packages to NPM | |||
|
|
|||
| As part of the release candidate (RC) process, all of the `@wordpress` packages are published to NPM. You may see messaging after the ["Build Gutenberg Plugin Zip" action](https://github.com/WordPress/gutenberg/actions/workflows/build-plugin-zip.yml) action has created the draft release that the ["Publish npm packages"](https://github.com/WordPress/gutenberg/actions/workflows/publish-npm-packages.yml) action requires someone with appropriate permissions to trigger the action. This is not the case as this process is automated and it will automatically run after the release notes are published. | |||
There was a problem hiding this comment.
This is not the case as this process is automated and it will automatically run after the release notes are published.
@ryanwelcher I found it hard to understand this last part. Is there any further clarification that can be added?
Maybe something like "As the release coordinator you don't need to take any action"?(this is my interpretation of what the sentence means, but I wasn't sure).
I'm looking to update the release docs at the moment, so let me know and I can include a small update to this part.
There was a problem hiding this comment.
@talldan you are correct. Feel free to make any clarifications you think are appropriate Thanks!
There was a problem hiding this comment.
Thanks, I made some changes here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
While running through the process to release the 14.8 RC, there was some confusion around publishing the npm packages. Once the “Build Gutenberg Plugin Zip" action had been completed and created the release notes draft, there was some messaging that the "Publish npm package" action required someone with correct permissions to trigger it.
This is not the case as the action is run after the release notes are published.
This PR adds a section to the release instructions to clarify this process.