|
| 1 | +--- |
| 2 | +SPDX-FileCopyrightText: 2025 PyThaiNLP Project |
| 3 | +SPDX-FileType: DOCUMENTATION |
| 4 | +SPDX-License-Identifier: CC0-1.0 |
| 5 | +--- |
| 6 | + |
1 | 7 | # How to cut a new release |
2 | 8 |
|
3 | 9 | 0. Check if the package can be built properly. |
4 | 10 | Include "[cd build]" in the commit message to trigger wheel building. |
5 | | -1. This project follows [semantic versioning][semver]. |
| 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]. |
6 | 14 | Ensure the version and release date fields (if any) in these files |
7 | 15 | have been updated to the version of the new planned release: |
8 | 16 | - `codemeta.json` |
|
13 | 21 | - `CITATION.cff` |
14 | 22 | - `README.md` |
15 | 23 | - `README.TH.md` |
16 | | -2. Navigate to the [releases page][releases] and click the |
| 24 | +3. Navigate to the [releases page][releases] and click the |
17 | 25 | "Draft a new release" button. |
18 | 26 | Only project maintainers are able to perform this step. |
19 | | -3. Then enter the new tag in the "Choose a tag" box. |
| 27 | +4. Then enter the new tag in the "Choose a tag" box. |
20 | 28 | The tag should begin with "v", as in, for instance, `v5.0.1`. |
21 | | -4. The release title should be the same as the new version tag. |
| 29 | +5. The release title should be the same as the new version tag. |
22 | 30 | For instance, the title could be `v5.0.1`. |
23 | | -5. Add a short summary of important changes in this release. |
24 | | - For example, deprecation or termination of support. |
25 | | - This should be similar to what have been logged in `CHANGELOG.md`. |
26 | | -6. Then click the "Generate release notes" button. |
| 31 | +6. Add a short summary of important changes in this release. |
| 32 | + _This should be similar to what have been logged in `CHANGELOG.md`._ |
| 33 | + Then click the "Generate release notes" button. |
27 | 34 | 7. You can optionally include any particular thank-you's to contributors or |
28 | 35 | reviewers in a note at the bottom of the release. |
29 | 36 | 8. You can then click "Publish release" button. |
|
0 commit comments