Skip to content

Commit

Permalink
Update release docs to document the need for a temporary brach used i…
Browse files Browse the repository at this point in the history
…n official releases version bumps
  • Loading branch information
jorgefilipecosta committed Feb 6, 2019
1 parent 669d0c5 commit 140b682
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/contributors/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,16 @@ Creating a release involves:

1. Checkout the release branch `git checkout release/x.x`.

**Note:** This branch should never be removed or rebased. This means in case of conflicts when creating PRs from this branch, create temporary branches in order to merge these PRs and avoid touching the release branch.
**Note:** This branch should never be removed or rebased. When we want to merge something from it to master and conflicts exist/may exist we use a temporary branch `bump/x.x`.

2. Create [a commit like this](https://github.com/WordPress/gutenberg/commit/00d01049685f11f9bb721ad3437cb928814ab2a2#diff-b9cfc7f2cdf78a7f4b91a753d10865a2), removing the `-rc.X` from the version number in `gutenberg.php`, `package.json`, and `package-lock.json`.
3. Create a Pull Request from the release branch into `master` using the changelog as a description and ensure the tests pass properly.
4. Tag the version. `git tag vx.x.0` from the release branch.
5. Push the tag `git push --tags`.
6. Merge the version bump pull request and avoid removing the release branch.
3. Create a new branch called `bump/x.x` from `release/x.x` and switch to it: `git checkout -b bump/x.x`.
4. Make sure the master branch is updated and rebase `bump/x.x` against it `git rebase master`.
5. Create a pull request from `bump/x.x` to `master`. Verify there are no conflicts and the continuous integrations tests pass.
6. Switch to the `release/x.x` branch. Tag the version from the release branch `git tag vx.x.0`.
7. Push the tag `git push --tags`.
8. Merge the version bump pull request.


##### Build the Plugin

Expand Down

0 comments on commit 140b682

Please sign in to comment.