Skip to main content

Maintainer release guide

The full operator runbook is docs/releasing.md. This page summarizes the checks that must remain true when changing release or documentation workflows.

Release inputs

The release workflow accepts pushed exact-SemVer tags in the form vX.Y.Z. It validates the tag commit, tests the module, checks the active four-language surface, and verifies release helpers and README snippets before native artifacts are handled.

The native matrix contains Linux amd64/arm64, macOS amd64/arm64, and Windows amd64 archives plus checksums.txt. Release builds inject the version through internal/version.BuildVersion.

Documentation deployment

The docs workflow runs on pull requests and pushes to main with Node 22. It deploys only a successful main build to the sunset-docs Pages project and then requests https://sunset.enolalab.com/.

Before changing the workflow, verify:

node scripts/validate-docs.mjs --root .
npm run build --prefix website
go test ./...

Do not invent release, package-manager, or custom-domain status that is not established by the repository or authenticated deployment tooling.