Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 2.39 KB

RELEASE.md

File metadata and controls

85 lines (64 loc) · 2.39 KB

Releasing HumbleBee

This repo publishes releases via GitHub Actions + GoReleaser on semver tags (v*).

One-time setup

  1. These repositories need write access for releasing:
  • grobmeier/humblebee (this repo)
  • grobmeier/homebrew-tap (tap)
  • grobmeier/scoop-bucket (Scoop bucket)
  1. Add GitHub Actions secrets in grobmeier/humblebee:
  • TAP_GITHUB_TOKEN: GitHub PAT with write access to grobmeier/homebrew-tap
  • SCOOP_GITHUB_TOKEN: GitHub PAT with write access to grobmeier/scoop-bucket

Notes:

  • The workflow uses secrets.GITHUB_TOKEN for creating the GitHub Release.
  • The PATs are only for pushing formula/manifest commits to the other repos.
  1. Ensure the release workflow + GoReleaser config are on main:
  • .github/workflows/release.yml
  • .goreleaser.yaml

Release steps

  1. (Optional) Validate the GoReleaser config:
goreleaser check
  1. Update main and ensure it’s green locally:
git checkout main
git pull
go test ./...
  1. Choose the version:
  • First release example: v0.1.0
  1. Create an annotated tag:
git tag -a v0.1.0 -m "v0.1.0"
  1. Push the tag:
git push origin v0.1.0
  1. Watch GitHub Actions:
  • In grobmeier/humblebee → Actions → release
  • The job runs GoReleaser and will:
    • create a GitHub Release with artifacts + checksums.txt
    • commit/update the Homebrew formula in grobmeier/homebrew-tap
    • commit/update the Scoop manifest in grobmeier/scoop-bucket
  1. Verify the release outputs:
  • GitHub Release contains:
    • humblebee_<version>_windows_amd64.zip (and other OS/arch archives)
    • checksums.txt
  • Homebrew: check the formula commit landed in grobmeier/homebrew-tap
  • Scoop: check the manifest commit landed in grobmeier/scoop-bucket

Optional: local dry run (recommended before tagging)

Requires GoReleaser installed:

goreleaser release --snapshot --clean

This builds artifacts locally without publishing.

Troubleshooting

  • Homebrew/Scoop publishing fails: re-check PAT permissions and that the secret names match

    • TAP_GITHUB_TOKEN
    • SCOOP_GITHUB_TOKEN

  • Wrong artifacts format on Windows: ensure .goreleaser.yaml has a format_overrides entry for windows -> zip

  • Build metadata: humblebee help prints Version: <version> (<commit>) after release builds

  • Release fails, remove tags local and remote:

    git tag -d v0.x.x git push --delete origin v0.x.x