Skip to content

Changelog instructions #6756

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
willhickey merged 2 commits into from
Jun 26, 2025
Merged

Changelog instructions #6756

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
983385a
Remove unused patch release instructions from changelog
willhickey Jun 26, 2025
f1ce0f8
Add changelog instructions for pruning the changelog when a new relea…
willhickey Jun 26, 2025
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
13 changes: 5 additions & 8 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,11 +262,8 @@ This simplifies the process of diffing between versions of the log.
* Update the edge, beta, and stable links
* Create new section: `vx.y+1.0 - Unreleased`
* Remove `Unreleased` annotation from vx.y.0 section.
* Create vx.y branch starting at that commit
* Tag that commit as vx.y.0

### When creating a new patch release:
* Commit to the release branch updating the changelog:
* Remove `Unreleased` annotation from `vx.y.z` section
* Add a new section at the top for `vx.y.z+1 - Unreleased`
* Tag that new commit as the new release
* Create vx.y branch starting at that commit.
* Commit to `vx.y` updating the changelog:
* Remove the `vx.y+1.0 - Unreleased` section
* Remove the channel links
* Tag vx.y.0 on the new branch