Przeglądaj źródła

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

docs: Consolidate changelog update steps into RELEASE.md

RELEASE.md already has a list of steps to perform when creating a new
branch. Updating CHANGELOG.md is one of those steps to perform, so move
the tasks over to make it harder to miss
steviez 2 dni temu
rodzic
commit
6045e25cc0
2 zmienionych plików z 8 dodań i 12 usunięć
  1. 0 12
      CHANGELOG.md
  2. 8 0
      RELEASE.md

+ 0 - 12
CHANGELOG.md

@@ -312,15 +312,3 @@ makes the feature code complete.
 * Link to any relevant feature gate issues or SIMDs.
 * Link to any relevant feature gate issues or SIMDs.
 * If you add entries on multiple branches use the same wording if possible.
 * If you add entries on multiple branches use the same wording if possible.
 This simplifies the process of diffing between versions of the log.
 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 - 0
RELEASE.md

@@ -101,9 +101,17 @@ Alternatively use the Github UI.
     ci/channel-info.sh
     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
 ### 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. 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 [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. 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.
 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.