Release procedure
git-byline uses SemVer, Release Please, and GoReleaser.
Version policy
- Tags use
vMAJOR.MINOR.PATCH. - Before 1.0,
featand breaking changes increment minor. fixincrements patch.fix(deps)increments patch.- Development tooling and GitHub Action updates do not create product releases.
- Release Please owns release pull requests,
CHANGELOG.md, versions, and tags. - The binary receives its version from the validated tag at link time. Local
builds report
dev.
Automation level
The repository starts at checks-only automation:
- Renovate may open pull requests.
- Humans review and merge dependency updates.
- Humans merge release pull requests.
- Merging a release pull request authorizes Release Please to create the tag and GitHub release.
- The protected
releaseenvironment restricts binary, checksum, and SBOM upload to version tags without requiring separate approval.
Enable dependency auto-merge only after a real non-major update proves all required checks and rollback. Enable release pull request auto-merge only after one successful manual release.
Required configuration
RELEASE_PAT: repository-scoped GitHub App or dedicated bot token with contents and workflows write access. The release workflow uses it to move the action major tag, because the workflow token cannot move a ref to a commit that changes.github/workflows.releaseenvironment: artifact upload restricted to version tags, without required reviewers.- Branch rules from REPOSITORY_SETTINGS.md.
Release Please can be disabled by removing the repository secret or disabling
release-please.yml. Artifact upload can be disabled by protecting or
disabling the release environment and release.yml. Disable both workflows
to stop all release publication.
Release steps
- Review Conventional Commits on
main. - Confirm all required checks pass.
- Review and merge the Release Please pull request.
- Confirm the generated tag points to the expected commit.
- Confirm
release.ymlstarts without environment approval and builds from the exact tag. - Verify six archives, six SBOM files, and
checksums.txt. - Install one artifact per supported operating system.
- Run
git-byline versionand compare it with the tag. - Review release notes and publish state.
- Tick
Publish this Action to the GitHub Marketplaceon the release so the action listing tracks it. The first publish needs the one-time GitHub Marketplace Developer Agreement and two-factor authentication.
If the tag event does not start publication, dispatch release.yml manually
with the existing tag. The workflow validates the tag and checks out that exact
ref.
Local dry run
go run ./tools/validate
syft version
goreleaser release --snapshot --clean
Inspect dist/:
git-byline_VERSION_linux_amd64.tar.gz
git-byline_VERSION_linux_arm64.tar.gz
git-byline_VERSION_macOS_amd64.tar.gz
git-byline_VERSION_macOS_arm64.tar.gz
git-byline_VERSION_windows_amd64.zip
git-byline_VERSION_windows_arm64.zip
checksums.txt
six archive SBOM files
Each archive contains only the binary, LICENSE, README.md, and
SECURITY.md.
Verification
- Tag matches
vMAJOR.MINOR.PATCH. - Binary output matches the tag.
- Checksums verify every archive.
- SBOM exists and is non-empty for every archive.
- Archive contents match the allowlist.
- No local path, secret, debug file, or source cache appears.
- Installation documentation matches actual names.
Bad release
- Stop further publication and auto-merge.
- Mark the release as withdrawn or draft.
- Do not delete a consumed tag.
- Fix source or release configuration.
- Publish a corrective patch.
- Document impact and upgrade guidance.