Skip to content

Commit b13f5db

Browse files
rustyrussellsangbida
authored andcommitted
doc: update release-checklist to make CHANGELOG.md more coherent.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
1 parent 1e19ebf commit b13f5db

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/contribute-to-core-lightning/release-checklist.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ Here's a checklist for the release process.
1818

1919
## Preparing for -rc1
2020

21-
1. Check that `CHANGELOG.md` is well formatted, ordered in areas, covers all signficant changes, and sub-ordered approximately by user impact & coolness.
21+
1. Make sure any `CHANGELOG.md` changes from point releases have been imported.
2222
2. Use `devtools/changelog.py` to collect the changelog entries from pull request commit messages and merge them into the manually maintained `CHANGELOG.md`. This does API queries to GitHub, which are severely ratelimited unless you use an API token: set the `GH_TOKEN` environment variable to a Personal Access Token from https://github.com/settings/tokens
23-
3. Create a new CHANGELOG.md heading to `v<VERSION>rc1`, and create a link at the bottom. Note that you should exactly copy the date and name format from a previous release, as the `build-release.sh` script relies on this.
24-
4. Update the package versions: `uv run make update-versions NEW_VERSION=v<VERSION>rc1`
25-
5. Create a PR with the above.
23+
3. Check that `CHANGELOG.md` is well formatted, ordered in areas, covers all signficant changes, and sub-ordered approximately by user impact & coolness.
24+
4. Manually remove any entries which were mentioned for in the previous point releases (they will be duplicates!)
25+
5. Create a new CHANGELOG.md heading to `v<VERSION>rc1`, and create a link at the bottom. Note that you should exactly copy the date and name format from a previous release, as the `build-release.sh` script relies on this.
26+
6. Update the package versions: `uv run make update-versions NEW_VERSION=v<VERSION>rc1`
27+
7. Create a PR with the above.
2628

2729
## Releasing -rc1
2830

0 commit comments

Comments
 (0)