This is an automated email from the ASF dual-hosted git repository. lhotari pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit 513b02c2c0b2a2f9279d54f1c57b40a5a21e8cf3 Author: Lari Hotari <[email protected]> AuthorDate: Thu Jul 31 16:16:17 2025 +0300 Add some release notes instructions --- contribute/release-note-guide.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/contribute/release-note-guide.md b/contribute/release-note-guide.md index b9407fa4dfe..b83e6ceb9e1 100644 --- a/contribute/release-note-guide.md +++ b/contribute/release-note-guide.md @@ -77,6 +77,34 @@ For feature releases, using the milestone: gh pr list -L 1000 --search "is:pr is:merged milestone:4.0.0" --json title,number,url | jq -r '.[] | "- \(.title) ([#\(.number)](\(.url)))"' | sort | pbcopy ``` +Copying from the clipboard to the release notes file + +First, move back to the pulsar-site directory, then: + +```shell +pbpaste >> release-notes/versioned/pulsar-${VERSION_WITHOUT_RC}.md +``` + +## Categorizing the release note entries + +There is a separate script that can automatically categorize the release note items. + +```shell +./scripts/release_notes_reorder_script.py release-notes/versioned/pulsar-${VERSION_WITHOUT_RC}.md +``` + +You need to check the results and sometimes manually reorder the entries. + +If you are releasing multiple maintenance versions at once, you can use another release as the reference for ordering, so you do not have to repeat the same manual reordering. + +```shell +./scripts/release_notes_reorder_script.py release-notes/versioned/pulsar-X.Y.Z.md release-notes/versioned/pulsar-${VERSION_WITHOUT_RC}.md +``` + +## Creating Java client release notes + +Copy the "Client" and applicable entries from "Library updates" into the client-java release notes. + ## Update the release note page The following steps are handled by the script `./scripts/generate_release_notes.py`.
