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 release docs to include RC #9887
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🏆
@@ -28,17 +68,23 @@ git push origin v3.1.1 | |||
``` | |||
4. Create a merge PR against master that only bumps the version number in `gutenberg.php`, `package.json`, and `package-lock.json`. | |||
|
|||
## Build the Release | |||
### Build the Release | |||
|
|||
Note: The `1.x.0` notation `git` and `svn` commands should be replaced with the version number of the new release. | |||
|
|||
* Run `git checkout master` and `git pull`. Make sure your local `master` is up to date; you can confirm this by opening `gutenberg.php` and checking for the version bump you merged previously. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is no longer true, because we can't build from master. We need to build from the last RC instead and we need to commit a version bump commit on the branch holding the last RC (or just locally above the tag) and also merge this commit back to master.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh snap, I thought this and figured I should update. I'll do another patch, didn't expect this to get merged so quickly! 😅
|
||
This guide applies to both release candidates and actual releases. The only difference between a release candidate and actual release is that the "push to repository" step is only done for actual releases and not release candidates. | ||
|
||
### Writing the Release Post and Changelog | ||
|
||
* Open the [recently updated PRs view](https://github.com/WordPress/gutenberg/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc) and find the PR where the last version bump occurred. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is no longer true because the version bump may have occured after a lot of merges in master not included in the final version. We need to find the first RC version bump instead.
@@ -28,17 +68,23 @@ git push origin v3.1.1 | |||
``` | |||
4. Create a merge PR against master that only bumps the version number in `gutenberg.php`, `package.json`, and `package-lock.json`. | |||
|
|||
## Build the Release | |||
### Build the Release | |||
|
|||
Note: The `1.x.0` notation `git` and `svn` commands should be replaced with the version number of the new release. | |||
|
|||
* Run `git checkout master` and `git pull`. Make sure your local `master` is up to date; you can confirm this by opening `gutenberg.php` and checking for the version bump you merged previously. | |||
* Run `./bin/build-plugin-zip.sh` from the root of project. This packages a zip file with a release build of `gutenberg.zip`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a warning in this script saying you're not master, we should remove it because aside tagging the first RC, we won't use master to release the versions anymore.
Thanks for the comments @youknowriad, I'll prep another PR with some tweaks to the script and the branches used in a few minutes 😄 |
fix #9631
Update the release docs to better outline our new release process and guide developers through the cherry-picking process.