Skip to content

RELEASE_SETUP.md

Latest commit

 

History

History
49 lines (33 loc) · 1.62 KB

RELEASE_SETUP.md

File metadata and controls

49 lines (33 loc) · 1.62 KB
Raw

Release Setup Instructions

This mirrors the stamp pipeline so we can tag v0.1.0 confidently.

✅ Files Added Here

  1. .goreleaser.yml – builds macOS/Linux (amd64+arm64), adds ldflags for version info, and updates the Homebrew tap.
  2. .github/workflows/release.yml – GitHub Actions workflow that runs on v* tags, runs tests, and invokes GoReleaser.
  3. Formula/whoopy.rb – reference Homebrew formula template to copy into totocaster/homebrew-tap.

📋 One-Time GitHub Tasks

  1. Homebrew tap – ensure https://github.com/totocaster/homebrew-tap exists (public) with a Formula/ dir. Copy Formula/whoopy.rb there on first release; GoReleaser will keep it updated afterward.
  2. Secrets – HOMEBREW_TAP_TOKEN is already set in repo secrets (thanks!). Nothing else required for release.

🚀 Cut a Release (v0.1.0)

# ensure tree is clean
git status

# update docs/changelog as needed, commit, push

# tag and push
git tag -a v0.1.0 -m "whoopy v0.1.0"
git push origin v0.1.0

The release workflow runs automatically. Watch it under Actions → Release.

✅ After Workflow Completes

  1. Check https://github.com/totocaster/whoopy/releases for uploaded archives + checksums.
  2. Verify the tap repo gained an updated Formula/whoopy.rb.
  3. Test install: 
    brew tap totocaster/tap
brew install whoopy
whoopy --version

🔁 Future Releases

Same as above: merge your work, tag v0.x.y, push the tag, watch GoReleaser do the rest.

📚 References