Releasing¶

Releases are automated via GoReleaser and GitHub Actions.

Release workflow¶

flowchart LR
  Tag["git tag vX.Y.Z"] --> Push["git push origin tag"]
  Push --> GHA["GitHub Actions"]
  GHA --> Build["Cross-platform build"]
  Build --> Publish["GitHub Release"]

Push a semantic version tag to trigger a release:

git tag v0.1.0
git push origin v0.1.0

The release workflow builds cross-platform binaries (Linux, macOS, Windows on amd64 and arm64) and publishes them to GitHub Releases.

Pre-release checklist¶

make ci passes on the release commit
make release-check validates GoReleaser config
make snapshot produces expected artifacts in ./dist/
CHANGELOG.md is up to date (make changelog if needed)

Tags are immutable

A pushed tag triggers a published release. Verify the snapshot build before tagging. To fix a bad release, publish a new patch version rather than reusing the tag.

Validate locally¶

make release-check
make snapshot

Snapshot artifacts are written to ./dist/ without publishing.

Changelog¶

Release notes are generated from conventional commits using git-cliff:

make changelog           # regenerate CHANGELOG.md
make changelog-current   # print notes for the latest tag