Skip to content

Commit 13d9995

Browse files
authored
Merge pull request #394 from wordpress-mobile/readme/release-instructions
Add Release Instructions to README
2 parents 2034fd0 + befd77a commit 13d9995

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,21 @@ Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues,
2020

2121
This guide also includes some tips about configuring your environment and IDE (e.g. VSCode) and how to run tests and documentation.
2222

23+
## Doing a new Release
24+
25+
When you need to do a new release of the `release-toolkit`, simply run `rake new_release` and follow the instructions.
26+
27+
> This task will:
28+
> - Show you the CHANGELOG/release notes it's about to use for that version
29+
> - Deduce which version number to use according to [SemVer](https://semver.org/) rules, and ask you to confirm that version number
30+
> - Create a `release/<x.y>` branch, update the version number in all the right places, and create a PR for those changes
31+
32+
Submit the PR, adding the `Releases` label to it and adding the `owl-team` as reviewers.
33+
34+
Once that PR is approved and merged, create a new GitHub Release, copy/pasting the CHANGELOG entries for that GH release's description.
35+
36+
> Publishing the GitHub Release will create the associated tag as well, which will trigger the CI job that will ultimately `gem push` the gem on RubyGems.
37+
2338
## Security
2439

2540
If you happen to find a security vulnerability, we would appreciate you letting us know at https://hackerone.com/automattic and allowing us to respond before disclosing the issue publicly.

0 commit comments

Comments
 (0)