Borg/docs/releasing.md
google-labs-jules[bot] 629a6e6464 Update documentation for CLI and library usage
- Update docs/cli.md to include all current commands (all, compile, run, decode) and correct terminology (TIM).
- Update docs/library.md with correct, runnable Go code examples and updated import paths.
- Update docs/development.md, docs/installation.md, and docs/releasing.md to reflect the project's Go version (1.25.0).
- Remove outdated "No functional changes" notes from documentation files.
2025-11-24 23:58:50 +00:00

33 lines
887 B
Markdown

# Releasing
This project is configured for GoReleaser.
## Prerequisites
- Create a GitHub personal access token with `repo` scope and export as `GITHUB_TOKEN` in your shell.
- Ensure a clean working tree and a tagged commit.
- Install goreleaser: https://goreleaser.com/install/
## Snapshot builds
Generate local artifacts without publishing:
- `goreleaser release --snapshot --clean`
Artifacts appear under `dist/`.
## Full release
1. Tag a new version:
- `git tag -a v0.1.0 -m "v0.1.0"`
- `git push origin v0.1.0`
2. Run GoReleaser:
- `GITHUB_TOKEN=... goreleaser release --clean`
This will:
- Build binaries for multiple OS/ARCH
- Produce checksums and archives
- Create/update a GitHub Release with changelog
- Optionally publish a Homebrew formula (if repository exists and permissions allow)
## Notes
- The Go toolchain version is 1.25 (see go.mod and go.work).