Skip to content

RELEASING.md

Latest commit

 

History

History
120 lines (95 loc) · 3.26 KB

RELEASING.md

File metadata and controls

120 lines (95 loc) · 3.26 KB
summary Release checklist for gogcli (GitHub release + Homebrew tap)

Releasing gogcli

This playbook mirrors the Homebrew + GitHub flow used in ../camsnap.

Always do all steps below (CI + changelog + tag + GitHub release artifacts + tap update + Homebrew sanity install). No partial releases.

Shortcut scripts (preferred, keep notes non-empty):

scripts/release.sh X.Y.Z
scripts/verify-release.sh X.Y.Z

Assumptions:

  • Repo: steipete/gogcli
  • Tap repo: ../homebrew-tap (tap: steipete/tap)
  • Homebrew formula name: gogcli (installs the gog binary)

0) Prereqs

  • Clean working tree on main.
  • Go toolchain installed (Go version comes from go.mod).
  • make works locally.
  • Access to the tap repo (e.g. steipete/homebrew-tap).
  • For signed macOS release binaries (recommended): GitHub Actions secrets set:
    • MACOS_SIGNING_CERT_BASE64 (base64-encoded .p12)
    • MACOS_SIGNING_CERT_PASSWORD
    • MACOS_CODESIGN_IDENTITY (e.g. Developer ID Application: …)

1) Verify build is green

make ci

Confirm GitHub Actions ci is green for the commit you’re tagging:

gh run list -L 5 --branch main

2) Update changelog

  • Update CHANGELOG.md for the version you’re releasing.

Example heading:

  • ## 0.1.0 - 2025-12-12

3) Commit, tag & push

git checkout main
git pull

# commit changelog + any release tweaks
git commit -am "release: vX.Y.Z"

git tag -a vX.Y.Z -m "Release X.Y.Z"
git push origin main --tags

4) Verify GitHub release artifacts

The tag push triggers .github/workflows/release.yml (GoReleaser). Ensure it completes successfully and the release has assets.

gh run list -L 5 --workflow release.yml
gh release view vX.Y.Z

Ensure GitHub release notes are not empty (mirror the changelog section).

If the workflow needs a rerun:

gh workflow run release.yml -f tag=vX.Y.Z

5) Update (or add) the Homebrew formula

In the tap repo (assumed sibling at ../homebrew-tap), create/update Formula/gogcli.rb.

Recommended formula shape (download GitHub release assets; preserves macOS code signature):

  • version "X.Y.Z"
  • url "https://github.com/steipete/gogcli/releases/download/vX.Y.Z/gogcli_X.Y.Z_darwin_arm64.tar.gz" (or darwin_amd64)
  • sha256 "<sha256>"
  • Install:
    • bin.install "gog"

Alternative (build-from-source; macOS binary will be ad-hoc signed, which can trigger repeated Keychain prompts with KeychainTrustApplication):

  • version "X.Y.Z"
  • url "https://github.com/steipete/gogcli/archive/refs/tags/vX.Y.Z.tar.gz"
  • sha256 "<sha256>"
  • depends_on "go" => :build
  • Build:
    • system "go", "build", *std_go_args(ldflags: "-s -w"), "./cmd/gog"

Compute the SHA256 for the tag tarball:

curl -L -o /tmp/gogcli.tar.gz https://github.com/steipete/gogcli/archive/refs/tags/vX.Y.Z.tar.gz
shasum -a 256 /tmp/gogcli.tar.gz

Commit + push in the tap repo:

cd ../homebrew-tap
git add Formula/gogcli.rb
git commit -m "gogcli vX.Y.Z"
git push origin main

6) Sanity-check install from tap

brew update
brew uninstall gogcli || true
brew untap steipete/tap || true
brew tap steipete/tap
brew install steipete/tap/gogcli
brew test steipete/tap/gogcli

gog --help

Notes

  • gog --version / gog version should report the release version post-install.
⚡