@@ -9,8 +9,9 @@ SPDX-License-Identifier: CC0-1.0
9
9
0 . Check if the package can be built properly.
10
10
Include "[ cd build] " in the commit message to trigger wheel building.
11
11
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 ] .
14
15
Ensure the version and release date fields (if any) in these files
15
16
have been updated to the version of the new planned release:
16
17
- ` codemeta.json `
@@ -21,20 +22,21 @@ SPDX-License-Identifier: CC0-1.0
21
22
- ` CITATION.cff `
22
23
- ` README.md `
23
24
- ` 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
25
26
"Draft a new release" button.
26
27
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.
28
29
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.
30
31
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.
32
34
_ This should be similar to what have been logged in ` CHANGELOG.md ` ._
33
35
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
35
37
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 ] ,
38
40
then the release will be published on both
39
41
the GitHub release page and also the [ Python Package Index] [ pypi ] .
40
42
0 commit comments