Skip to content

RELEASING.md

Latest commit

 

History

History
67 lines (43 loc) · 1.85 KB

RELEASING.md

File metadata and controls

67 lines (43 loc) · 1.85 KB

Releasing

Releases are built by a GitHub Actions workflow and published as draft GitHub Releases.

Prerequisites

  • Push access to main
  • A changelog entry for the version being released (stable releases only)

Steps

1. Update the changelog

Move items from ## Unreleased into a new version section in CHANGELOG.md:

## v0.1.0

### Added
- ...

Commit this to main and push.

2. Trigger the release workflow

Go to Actions > Release > Run workflow on GitHub and enter the version. Accepted formats:

  • v0.1.0 — stable release (requires changelog entry)
  • v0.1.0-alpha.1, v0.1.0-rc.1 — pre-release (changelog not required)

The workflow will:

  1. Validate the version format
  2. Verify a matching changelog entry exists (stable releases only)
  3. Extract release notes from the changelog, or generate a placeholder for pre-releases
  4. Create and push a git tag
  5. Build binaries for Linux and Windows (amd64 + arm64) via GoReleaser
  6. Collect third-party dependency licenses via go-licenses
  7. Create a draft GitHub Release with the binaries and license notices

GoReleaser automatically marks releases with pre-release suffixes (e.g. -alpha.1) as pre-releases on GitHub.

3. Review and publish

The release is created as a draft. Review the release notes and attached archives on the Releases page, then click Publish.

What's in the archives

Each release archive contains:

  • cctote binary (or cctote.exe on Windows)
  • LICENSE (project license, 0BSD)
  • third_party_licenses/ directory with license files for all dependencies

Local testing

To test the release build locally:

# Collect licenses (requires go-licenses)
go install github.com/google/go-licenses@latest
mise run licenses

# Dry-run GoReleaser
goreleaser release --snapshot --clean