summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMartin Nordholts <enselic@gmail.com>2023-10-17 16:06:59 +0200
committerMartin Nordholts <enselic@gmail.com>2023-10-18 21:33:44 +0200
commita5a7ede698878ef22f87a9b6252095be3563411b (patch)
tree7dab30b7c13c74431412e94d6f0c97dfc8c9e2e4 /doc
parentb551049706ce7a336bbbe181feb222d31b061bf9 (diff)
release-checklist.md: Adapt to new auto-merge workflow
Diffstat (limited to 'doc')
-rw-r--r--doc/release-checklist.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/release-checklist.md b/doc/release-checklist.md
index 8a8bca88..f56f7eb1 100644
--- a/doc/release-checklist.md
+++ b/doc/release-checklist.md
@@ -9,7 +9,16 @@
- [ ] Update the version and the min. supported Rust version in `README.md` and
`doc/README-*.md`. Check with
`git grep -i -e 'rust.*1\.' -e '1\..*rust' | grep README | grep -v tests/`.
-- [ ] Update `CHANGELOG.md`. Introduce a section for the new release.
+
+## CHANGELOG.md updates
+
+- [ ] Go to https://github.com/sharkdp/bat/releases/new, click "Choose a tag",
+ type the name of the tag that will be created later, click "Generate release
+ notes". DO NOT ACTUALLY CREATE ANY RELEASE IN THIS STEP.
+- [ ] Compare current `CHANGELOG.md` with auto-generated release notes and add
+ missing entries. Expect in particular dependabot PRs to not be in
+ `CHANGELOG.md` since they are [auto-merged] if CI passes.
+- [ ] Introduce a section for the new release and perform final touch-ups.
## Update syntaxes and themes (build assets)
@@ -71,3 +80,5 @@
```
+
+[auto-merged]: https://github.com/sharkdp/bat/blob/master/.github/workflows/Auto-merge-dependabot-PRs.yml