From 3b361cc643165ea3719d1f3ce6fe1060e161c864 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Boschi?= Date: Wed, 27 Mar 2024 09:37:44 +0100 Subject: [PATCH] docs: improve release notes generation --- site3/website/src/pages/community/release-guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site3/website/src/pages/community/release-guide.md b/site3/website/src/pages/community/release-guide.md index 73b99dc456f..ed2e0e1e226 100644 --- a/site3/website/src/pages/community/release-guide.md +++ b/site3/website/src/pages/community/release-guide.md @@ -177,15 +177,15 @@ To compare, you can use the following link from GitHub: #### Prepare Release Notes -After review the release notes on both GitHub, you should write the release notes under `site3/website/src/release-notes.md` and then send out a pull request for review. +After reviewing the release notes on both GitHub, you should write the release notes under `site3/website/src/release-notes.md` and then send out a pull request for review. To export the PR descriptions, you can use the [GitHub CLI](https://cli.github.com/). -After the setup, you can run this command to get the lit of changes. Then they can be copied in the release notes file: +After the setup, you can run this command to get the list of changes. Then they can be copied in the release notes file: ``` gh pr list -R apache/bookkeeper -l release/4.16.5 -s merged --json title,url,number -t '{{range .}}* {{.title}} [PR #{{.number}}]({{.url}}) {{"\n"}}{{end}}' ``` -After copying, the list you will have to manually split into bugs, features and dependency upgrades. +After copying the list, you will have to manually split them into bugs, features and dependency upgrades. Internal changes (CI, tests) that don't modify the production code can be omitted (if not relevant for users). ### Prepare release branch