release.md

SPDX-FileCopyrightText	SPDX-FileType	SPDX-License-Identifier
2025 PyThaiNLP Project	DOCUMENTATION	CC0-1.0

How to cut a new release

0. Check if the package can be built properly. Include "[cd build]" in the commit message to trigger wheel building.
1. Update CHANGELOG.md with a short summary of important changes since the previous stable release. For example, deprecation or termination of support.
2. This project follows semantic versioning. Ensure the version and release date fields (if any) in these files have been updated to the version of the new planned release:
   • codemeta.json
   • pyproject.toml
   • setup.cfg
   • setup.py
   • CHANGELOG.md
   • CITATION.cff
   • README.md
   • README.TH.md
3. Navigate to the releases page and click the "Draft a new release" button. Only project maintainers are able to perform this step.
4. Then enter the new tag in the "Choose a tag" box. The tag should begin with "v", as in, for instance, v5.0.1.
5. The release title should be the same as the new version tag. For instance, the title could be v5.0.1.
6. Add a short summary of important changes since the previous stable release. This should be similar to what have been logged in CHANGELOG.md. Then click the "Generate release notes" button.
7. You can optionally include any particular thank-you's to contributors or reviewers in a note at the bottom of the release.
8. You can then click "Publish release" button.
9. If the CI run is successful, then the release will be published on both the GitHub release page and also the Python Package Index.