docs: describe how the Homebrew tap is actually updated - #26
Merged
Conversation
RELEASING.md described a HOMEBREW_TAP_TOKEN setup step that was never completed and cannot be completed without admin on this repo. The v0.2.0 release published its binaries and then failed on the cask step with 401. The tap now updates itself: a workflow there polls this repo's public releases and commits with its own GITHUB_TOKEN, so no cross-repo secret is involved. Documents that, drops the stale setup instructions, and records the three things that cost time working this out: the tap serves a cask and a leftover formula silently outranks it, locally built archives are not byte-reproducible so their hashes break every install, and GoReleaser infers the release repo from the git remote.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RELEASING.mddocumented aHOMEBREW_TAP_TOKENsetup step that was never completed and cannot be completed without admin on this repo. The v0.2.0 release published its binaries fine and then failed on the cask step with401 Bad credentials.The tap now updates itself instead: a workflow there polls this repo's public releases hourly, regenerates
Casks/greenlight.rbfrom the publishedchecksums.txt, and commits with its ownGITHUB_TOKEN. Reading a public repo's releases needs no credentials and a workflow can always write to its own repo, so that path needs no secret and no admin. Verified end to end: the commit step ran, the bot pushed, andbrew install revylai/tap/greenlightnow yields 0.2.0 withplayscan.Also records the three things that cost time working this out:
Formula/greenlight.rbsilently outranks it (that is why the tap kept serving v0.1.0). GoReleaser'sbrewsoutput is deprecated and now failsgoreleaser check.--snapshotcarries hashes that fail verification on every install. Hashes must come from the release'schecksums.txt.If
HOMEBREW_TAP_TOKENis ever configured, both paths coexist: the tap workflow emits output byte-identical to GoReleaser's template, so whichever runs second is a no-op rather than a revert.Note
Low Risk
Documentation-only change with no runtime, auth, or release workflow code modifications in this diff.
Overview
Rewrites
RELEASING.mdso release docs match how installs actually work today, instead of assuming GoReleaser pushes the tap withHOMEBREW_TAP_TOKEN.The one-time
HOMEBREW_TAP_TOKENsetup is removed as a required step. Releases are described as tag-driven GoReleaser builds that publish GitHub binaries and checksums only. Cutting a release now tells you to bumpversioninmetadata.jsonand.claude-plugin/plugin.jsonin a normal PR before tagging, uses an annotated tag example (v0.2.0), and putsgoreleaser checkbefore the snapshot dry-run.A new “How the Homebrew tap is updated” section explains why the in-repo
homebrew_caskspush failed (401without admin-configuredHOMEBREW_TAP_TOKEN), thatRevylAI/homebrew-tapupdates itself via an hourly workflow that regeneratesCasks/greenlight.rbfrom public releases, and how to verify withbrew update/brew info --cask. It notes optional coexistence if the token is ever added.“Gotchas worth knowing” adds operational pitfalls: cask vs formula (leftover
Formula/greenlight.rbwins), checksums must come from releasechecksums.txt(not local--snapshotbuilds), and GoReleaser repo inference on forks (doc references pinningrelease.githubin.goreleaser.yml).Reviewed by Cursor Bugbot for commit 372a9ec. Bugbot is set up for automated code reviews on this repo. Configure here.