Releases

Versions are semver and cut by release-please off master. Conventional commit subjects drive the bump: feat: takes the minor, fix: the patch. The action opens a release pull request that carries the version into pyproject.toml and writes CHANGELOG.md; merging it tags vX.Y.Z and publishes the release.

The image installs a release by source tarball, so nothing has to be attached to it:

https://github.com/romm-streaming/romm-broker/archive/refs/tags/vX.Y.Z.tar.gz

While the version is below 1.0.0 a breaking change still takes the minor. Going to 1.0.0 is a deliberate call, made with a Release-As: 1.0.0 commit footer.

What a release triggers

1. release.yml runs release-please on every push to master. It keeps the release PR up to date with the commits since the last tag; merging that PR creates the tag and the GitHub release.
2. linuxserver's docker-webstation pipeline polls the latest release on a schedule and, when it differs from the version baked into the published webstation:romm image, rebuilds the image with BROKER_RELEASE pinned to the new tag. See Inside the image.
3. docs.yml rebuilds this site on every push to master that touches the docs or the package, so the developer reference always reflects the current source.

Changelog

The full history is in CHANGELOG.md at the repository root, and each GitHub release carries the same notes.