This document describes how we handle versioning and publishing new releases of the Hiero Python SDK.
We use Semantic Versioning for this project:
MAJOR.MINOR.PATCH
- MAJOR: Breaking changes
- MINOR: Backward-compatible new features
- PATCH: Bug fixes and other minor changes
-
Update the Version
Decide whether the changes are major, minor, or patch increments. -
Update the Changelog
Move your entries from the [Unreleased] section inCHANGELOG.md
to a new version heading with today’s date (e.g.,## [0.2.0] - 2025-02-20
). -
Create a Release Branch
release-v0.2.0
or similar (e.g.,release-v0.2.0-beta.1
for beta versions).
-
Run Tests
- Ensure all tests pass locally (run
pytest
). - Confirm CI passes (integration tests, etc.).
- Ensure all tests pass locally (run
-
Merge into
main
- Create a Pull Request from
release-vX.X.X
intomain
. - Wait for code review, ensure everything is green.
- Create a Pull Request from
-
Tag the Release
Once merged, create a git tag with the new version:git tag -a v0.2.0 -m "Release 0.2.0" git push origin v0.2.0