Skip to content

Commit 42acd10

Browse files
authored
Update release.md
1 parent 6e0edbe commit 42acd10

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

release.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ SPDX-License-Identifier: CC0-1.0
99
0. Check if the package can be built properly.
1010
Include "[cd build]" in the commit message to trigger wheel building.
1111
1. Update `CHANGELOG.md` with a short summary of important changes since
12-
the previous release. For example, deprecation or termination of support.
13-
2. This project follows [semantic versioning][semver].
12+
the previous stable release.
13+
For example, deprecation or termination of support.
14+
3. This project follows [semantic versioning][semver].
1415
Ensure the version and release date fields (if any) in these files
1516
have been updated to the version of the new planned release:
1617
- `codemeta.json`
@@ -21,20 +22,21 @@ SPDX-License-Identifier: CC0-1.0
2122
- `CITATION.cff`
2223
- `README.md`
2324
- `README.TH.md`
24-
3. Navigate to the [releases page][releases] and click the
25+
4. Navigate to the [releases page][releases] and click the
2526
"Draft a new release" button.
2627
Only project maintainers are able to perform this step.
27-
4. Then enter the new tag in the "Choose a tag" box.
28+
5. Then enter the new tag in the "Choose a tag" box.
2829
The tag should begin with "v", as in, for instance, `v5.0.1`.
29-
5. The release title should be the same as the new version tag.
30+
6. The release title should be the same as the new version tag.
3031
For instance, the title could be `v5.0.1`.
31-
6. Add a short summary of important changes in this release.
32+
7. Add a short summary of important changes since the previous stable
33+
release.
3234
_This should be similar to what have been logged in `CHANGELOG.md`._
3335
Then click the "Generate release notes" button.
34-
7. You can optionally include any particular thank-you's to contributors or
36+
9. You can optionally include any particular thank-you's to contributors or
3537
reviewers in a note at the bottom of the release.
36-
8. You can then click "Publish release" button.
37-
9. If [the CI][ci] run is [successful][actions],
38+
10. You can then click "Publish release" button.
39+
11. If [the CI][ci] run is [successful][actions],
3840
then the release will be published on both
3941
the GitHub release page and also the [Python Package Index][pypi].
4042

0 commit comments

Comments
 (0)