brief

Release

Current Version

The current release version comes from the root VERSION file:

v0.1.1

The repo is expected to stay in v0.x.x until a future public v1 release.

CLI Version Output

The installed binary reports its version with:

brief -v
brief --version

Source of Truth

The human-edited version source is:

• VERSION

The Makefile and release workflow derive their version from that file.

Changelog

Release notes start in:

• CHANGELOG.md

Git Tags

The release workflow uses semver-style tags:

v0.1.0
v0.1.1
v0.2.0

GitHub Release Workflow

The repo now includes:

• .github/workflows/release.yml

That workflow is configured to:

• trigger automatically on pushes to main
• read the release version from the root VERSION file
• validate that the VERSION value matches vX.Y.Z
• skip release creation if that tag already exists
• create and push the tag automatically when needed
• build release artifacts for:
  • linux/amd64
  • linux/arm64
  • darwin/amd64
  • darwin/arm64
  • windows/amd64
• publish those artifacts to a GitHub Release

Maintainer Release Flow

Releases are now intended to be cut automatically from main.

High-level flow:

1. Update the root VERSION file in your change.
2. Merge the release-ready change to main.
3. GitHub Actions reads VERSION, creates the tag if needed, builds artifacts, and publishes the GitHub Release.

v0.1.1

This removes the need to run git tag ..., git push <tag>, or manually dispatch a release workflow.

Version Source Of Truth

The only file a developer needs to edit to change the intended release version is:

• VERSION

Local Build With Version

The Makefile applies release linker flags and derives the version from the root VERSION file.

Examples:

make build
make install

The local build/install flow derives the version from the root VERSION file.

Override locally if needed:

make build VERSION=v0.1.1