Skip to content

Update post-release instructions for non-patch releases #1292

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Update post-release instructions for non-patch releases #1292

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions etc/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,27 @@ Sync the entries in the patch release section to be consistent with the entries

#### ... for a Non-Patch Release

Checkout the `releases/vX.Y` release branch.

```bash
git checkout releases/vX.Y
git pull
```

Add a section for the next patch release, e.g. following a `1.2.0` release:

```md
## 1.2.1 [Unreleased]

<!-- Will contain entries for the next patch release. -->

## 1.2.0 <!-- Just released. -->

## 1.1.0 <!-- Prior release. -->
```

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).

Checkout the `post-release-changes` branch.

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