Skip to content

Commit 3f437da

Browse files
committed
ReleaseChecklist: Emphasize separate changelog and version commits
1 parent b9d06b4 commit 3f437da

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

ReleaseChecklist.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@
1313
- [ ] Run `make linkcheck` from within `docs/` and fix any broken links it finds. Ignore false positives caused by `href` anchors and dummy links not meant to work.
1414

1515
### Changelog
16-
- [ ] Sort the changelog entries alphabetically and correct any errors you notice.
17-
- [ ] Create a commit on a new branch that updates the ``Changelog`` to include a release date.
16+
- [ ] Sort the changelog entries alphabetically and correct any errors you notice. Commit it.
17+
- [ ] Update the changelog to include a release date.
1818
- [ ] Run ``scripts/update_bugs_by_version.py`` to regenerate ``bugs_by_version.json`` from the changelog and ``bugs.json``.
19-
- [ ] Create a pull request and wait for the tests, merge it.
19+
Make sure that the resulting ``bugs_by_version.json`` has a new, empty entry for the new version.
20+
- [ ] Commit changes, create a pull request and wait for the tests. Then merge it.
2021
- [ ] Copy the changelog into the release blog post.
2122

2223
### Create the Release

0 commit comments

Comments
 (0)