From 3f437da2a40fc1568b07b4003c336fea4a0211d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20=C5=9Aliwak?= Date: Mon, 8 Aug 2022 18:14:25 +0200 Subject: [PATCH] ReleaseChecklist: Emphasize separate changelog and version commits --- ReleaseChecklist.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/ReleaseChecklist.md b/ReleaseChecklist.md index 7c78db457..821588f37 100644 --- a/ReleaseChecklist.md +++ b/ReleaseChecklist.md @@ -13,10 +13,11 @@ - [ ] 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. ### Changelog - - [ ] Sort the changelog entries alphabetically and correct any errors you notice. - - [ ] Create a commit on a new branch that updates the ``Changelog`` to include a release date. + - [ ] Sort the changelog entries alphabetically and correct any errors you notice. Commit it. + - [ ] Update the changelog to include a release date. - [ ] Run ``scripts/update_bugs_by_version.py`` to regenerate ``bugs_by_version.json`` from the changelog and ``bugs.json``. - - [ ] Create a pull request and wait for the tests, merge it. + Make sure that the resulting ``bugs_by_version.json`` has a new, empty entry for the new version. + - [ ] Commit changes, create a pull request and wait for the tests. Then merge it. - [ ] Copy the changelog into the release blog post. ### Create the Release