Releases and Versioning

The steps below mirror docs/deploy.md, "Releases", which is the source of truth.

MarketClock uses semantic versioning: vMAJOR.MINOR.PATCH.

Version	Means
0.x	before the public launch; the API can still change between minor versions; marked pre-release
1.0.0	the live launch at marketclock.ahmershah.dev; after it, a breaking API change needs a new major version and /api/v2
minor	new features, no breaking changes
patch	fixes only

A release is a tag vX.Y.Z on main with a GitHub release; the version in backend/pyproject.toml and frontend/package.json matches it.

Making a release

1. Set the version in backend/pyproject.toml and frontend/package.json in a pull request.
2. After the merge, tag the merge commit and publish the release with notes listing the merged pull requests since the previous tag:

git checkout main && git pull
git tag -a vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z
gh release create vX.Y.Z --verify-tag --title "vX.Y.Z" --generate-notes   # add --prerelease before 1.0