Releasing¶

Leo uses GoReleaser and GitHub Actions to automate releases. Pushing a version tag triggers the full pipeline: CI validation, cross-platform builds, and GitHub Release creation.

How It Works¶

git tag v0.2.0 ──> GitHub Actions ──> CI (test + lint)
                                        │
                                        ▼
                                    GoReleaser
                                    ├── Build binaries (darwin/linux × amd64/arm64)
                                    ├── Create GitHub Release with changelog
                                    └── Upload archives + checksums

The release workflow (.github/workflows/release.yml) calls the CI workflow as a prerequisite — no release is published unless tests and lint pass.

Creating a Release¶

1. Ensure main is ready¶

git checkout main
git pull
make test
make lint

2. Tag and push¶

Use the make tag shortcut:

make tag V=0.3.3

This creates an annotated tag v0.3.3 and pushes it to origin. Equivalent to:

git tag -a v0.3.3 -m "Release v0.3.3"
git push origin v0.3.3

3. Monitor the release¶

The Release workflow runs automatically. When it completes, the Releases page will have:

• Release notes auto-generated from commit history
• Archives for each platform: leo_0.3.3_darwin_amd64.tar.gz, etc.
• A checksums.txt file

Versioning¶

Leo follows Semantic Versioning:

Tags must use the v prefix (e.g., v1.2.3, not 1.2.3).

Changelog¶

The changelog is generated automatically from commit messages between tags. Commits prefixed with docs:, test:, or chore: are excluded. Use conventional commits for clean release notes:

feat: add background daemon mode
fix: resolve config resolution on nested paths
refactor: simplify cron marker parsing

To edit release notes after publishing, use the GitHub Releases web UI.

Install Script¶

The repo includes an install.sh that users can curl-pipe to install the latest release:

curl -fsSL https://raw.githubusercontent.com/blackpaw-studio/leo/refs/heads/main/install.sh | sh

The script auto-detects OS and architecture, downloads the matching archive from the GitHub Release, and installs the binary to ~/.local/bin (or INSTALL_DIR).

Testing Locally¶

To verify the GoReleaser configuration without publishing:

make snapshot

This creates a full build in dist/ without pushing anything.

Setup (Maintainers)¶

GITHUB_TOKEN is provided automatically by GitHub Actions — no additional secrets are needed.

Troubleshooting¶

CI fails on tag push

Fix the issue on main, delete the tag, and re-tag:

git tag -d v0.3.3
git push origin :refs/tags/v0.3.3
# fix and push to main
make tag V=0.3.3

GoReleaser config errors

Validate locally before tagging:

goreleaser check
make snapshot