Skip to content

Commit 73703de

Browse files
committed
[cd build] Update release.md
Signed-off-by: Arthit Suriyawongkul <[email protected]>
1 parent e9684fa commit 73703de

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

release.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,20 @@
1212
- `README.md`
1313
- `README.TH.md`
1414
- `CHANGELOG.md`
15-
2. Navigate to the
16-
[releases page][releases] and
17-
click the "Draft a new release" button.
15+
2. Navigate to the [releases page][releases] and click the
16+
"Draft a new release" button.
1817
Only project maintainers are able to perform this step.
1918
3. Then enter the new tag in the "Choose a tag" box.
2019
The tag should begin with "v", as in, for instance, `v5.0.1`.
2120
4. The release title should be the same as the new version tag.
2221
For instance, the title could be `v5.0.1`.
23-
5. The click the "Generate release notes" button.
24-
6. You can optionally include any particular thank-you's to contributors or
22+
5. Add a short summary of important changes in this release.
23+
For example, deprecation or termination of support.
24+
6. Then click the "Generate release notes" button.
25+
7. You can optionally include any particular thank-you's to contributors or
2526
reviewers in a note at the bottom of the release.
26-
7. You can then click "Publish release" button.
27-
8. If [the CI][ci] run is [successful][actions],
27+
8. You can then click "Publish release" button.
28+
9. If [the CI][ci] run is [successful][actions],
2829
then the release will be published on both
2930
the GitHub release page and also the [Python Package Index][pypi].
3031

0 commit comments

Comments
 (0)