Releasing¶
Versions are plain X.Y.Z tags (no v prefix), created by CI.
git checkout -b release/0.2.0./dev release 0.2.0: updatesVERSIONand inserts an empty dated0.2.0section inCHANGELOG.md.- By hand, until https://github.com/nikolareljin/script-helpers/issues/137 is
fixed:
- set
__version__intriaina/__init__.pyto the same version (tests/test_version.pyfails otherwise); - move the entries from
## [Unreleased]into the new section, grouped under Added / Changed / Fixed, and leave## [Unreleased]empty. The release notes are that section; left empty, the release has empty notes.
- set
bash scripts/check-changelog.shmust print the new version.- Commit, push, open a pull request.
- On merge,
auto-tag.ymltags0.2.0through the ci-helpersauto-tag.ymlpreset, then the ci-helpersrelease-build.ymlpreset runs the tests, buildsdist/triaina-0.2.0.tar.gzwithmake distand publishes the GitHub release with notes generated from the CHANGELOG section.
The archive contains triaina/ (the package), scripts/ (the three CLIs plus
script-helpers' helpers.sh and lib/), config/, deploy/, assets/,
pyproject.toml, requirements.txt, README.md, LICENSE and
CHANGELOG.md.
If the release job fails after tagging, fix the cause and re-run the failed job from the Actions tab; the tag already exists and is reused.