|
12 | 12 | - `README.md` |
13 | 13 | - `README.TH.md` |
14 | 14 | - `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. |
18 | 17 | Only project maintainers are able to perform this step. |
19 | 18 | 3. Then enter the new tag in the "Choose a tag" box. |
20 | 19 | The tag should begin with "v", as in, for instance, `v5.0.1`. |
21 | 20 | 4. The release title should be the same as the new version tag. |
22 | 21 | 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 |
25 | 26 | 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], |
28 | 29 | then the release will be published on both |
29 | 30 | the GitHub release page and also the [Python Package Index][pypi]. |
30 | 31 |
|
|
0 commit comments