Skip to content

docs: Add step to update CHANGELOG.md in RELEASE.md #8856

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
steviez merged 1 commit into from
Nov 19, 2025
Merged

docs: Add step to update CHANGELOG.md in RELEASE.md #8856

Show file tree
Hide file tree
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
12 changes: 0 additions & 12 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,15 +312,3 @@ makes the feature code complete.
* Link to any relevant feature gate issues or SIMDs.
* If you add entries on multiple branches use the same wording if possible.
This simplifies the process of diffing between versions of the log.

## Maintaining This Changelog
### When creating a new release branch:
* Commit to master updating the changelog:
* 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.
* 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
8 changes: 8 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,17 @@ Alternatively use the Github UI.
ci/channel-info.sh
```

### Update the Changelog

Create a PR that makes the following updates to [CHANGELOG.md](https://github.com/anza-xyz/agave/blob/master/CHANGELOG.md) in master:
* Advance the channel links with the newly created branch becoming beta.
* Add a new section `X.Y.0-Unreleased` for the new master version.
* Remove the `Unreleased` annotation for the section that has now become beta.

### Miscellaneous Clean up

1. Pin the spl-token-cli version in the newly promoted stable branch by setting `splTokenCliVersion` in scripts/spl-token-cli-version.sh to the latest release that depends on the stable branch (usually this will be the latest spl-token-cli release).
1. Update [CHANGELOG.md](https://github.com/anza-xyz/agave/blob/master/CHANGELOG.md) to remove the channel links on the new branch. Additionally, remove any wording about the new branch being unreleased.
1. Update [CODEOWNERS](https://github.com/anza-xyz/agave/blob/master/.github/CODEOWNERS) to `* @anza-xyz/backport-reviewers` on the new branch.
1. Update [mergify.yml](https://github.com/anza-xyz/agave/blob/master/.mergify.yml) to add backport actions for the new branch and remove actions for the obsolete branch.
1. Adjust the [Github backport labels](https://github.com/anza-xyz/agave/labels) to add the new branch label and remove the label for the obsolete branch.
Expand Down