Skip to content

Commit 513b02c

Browse files
committed
Add some release notes instructions
1 parent 76575ab commit 513b02c

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

contribute/release-note-guide.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,34 @@ For feature releases, using the milestone:
7777
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
7878
```
7979

80+
Copying from the clipboard to the release notes file
81+
82+
First, move back to the pulsar-site directory, then:
83+
84+
```shell
85+
pbpaste >> release-notes/versioned/pulsar-${VERSION_WITHOUT_RC}.md
86+
```
87+
88+
## Categorizing the release note entries
89+
90+
There is a separate script that can automatically categorize the release note items.
91+
92+
```shell
93+
./scripts/release_notes_reorder_script.py release-notes/versioned/pulsar-${VERSION_WITHOUT_RC}.md
94+
```
95+
96+
You need to check the results and sometimes manually reorder the entries.
97+
98+
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.
99+
100+
```shell
101+
./scripts/release_notes_reorder_script.py release-notes/versioned/pulsar-X.Y.Z.md release-notes/versioned/pulsar-${VERSION_WITHOUT_RC}.md
102+
```
103+
104+
## Creating Java client release notes
105+
106+
Copy the "Client" and applicable entries from "Library updates" into the client-java release notes.
107+
80108
## Update the release note page
81109

82110
The following steps are handled by the script `./scripts/generate_release_notes.py`.

0 commit comments

Comments
 (0)