Skip to content

Commit e558290

Browse files
authored
Update post-release instructions for non-patch releases (#1292)
1 parent 021528e commit e558290

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

etc/releasing.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,27 @@ Sync the entries in the patch release section to be consistent with the entries
829829
830830
#### ... for a Non-Patch Release
831831

832+
Checkout the `releases/vX.Y` release branch.
833+
834+
```bash
835+
git checkout releases/vX.Y
836+
git pull
837+
```
838+
839+
Add a section for the next patch release, e.g. following a `1.2.0` release:
840+
841+
```md
842+
## 1.2.1 [Unreleased]
843+
844+
<!-- Will contain entries for the next patch release. -->
845+
846+
## 1.2.0 <!-- Just released. -->
847+
848+
## 1.1.0 <!-- Prior release. -->
849+
```
850+
851+
Commit the changes to the `releases/vX.Y` branch and push the branch to the remote repository (a PR is not required for this step).
852+
832853
Checkout the `post-release-changes` branch.
833854

834855
Add a section for the next minor release, e.g. following a `1.3.0` release:

0 commit comments

Comments
 (0)