Skip to content

Point Homebrew instructions at the v4 cask - #191

Closed
robzolkos wants to merge 2 commits into
masterfrom
readme-homebrew-v4
Closed

Point Homebrew instructions at the v4 cask#191
robzolkos wants to merge 2 commits into
masterfrom
readme-homebrew-v4

Conversation

@robzolkos

@robzolkos robzolkos commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

v4.0.0 published Casks/fizzy.rb and fizzy.json to basecamp/homebrew-tap, so the README's Homebrew section is now out of date in a way that will break.

The problem

README.md currently tells new users:

brew install robzolkos/fizzy-cli/fizzy-cli

That command breaks as soon as robzolkos/homebrew-fizzy-cli#2 lands, which removes Formula/fizzy-cli.rb in favour of tap_migrations.json. Two more stale bits:

  • "Fizzy 4 release candidates are available from Releases" — 4.0.0 is stable now
  • The cask command was buried in a [!WARNING] saying it's "for Fizzy 4 stable once it is released" — it is released, so the warning now reads as don't use this

Changes

  • brew install --cask basecamp/tap/fizzy becomes the primary Homebrew instruction
  • Retitled to Homebrew (macOS and Linux) — the generated cask ships on_linux blocks for amd64/arm64
  • Kept the "RCs are not published to Homebrew" note, unwrapped from the stale warning
  • Added the manual upgrade path for 3.x users

Scoop section left as-is — it was previously broken (no manifest in the tap), and v4.0.0 published fizzy.json, so it is now correct.

Why the manual upgrade path is documented

The tap migration is not silent for most users. Homebrew's migrate_tap_migration only auto-migrates when basecamp/tap is already tapped locally. Otherwise it hits the untrusted-tap gate and prints commands rather than running them, because Homebrew will not tap a third-party tap without explicit brew trust. Users who already have basecamp/tap (basecamp-cli users) get the automatic unlinkcleanupinstall --cask path.

Merge order

Merge this before robzolkos/homebrew-fizzy-cli#2. This PR is safe now — it documents a cask that already exists and is verified installable. Merging the tap PR first leaves a window where the README hands people a deleted formula.

One sentence here ("that tap now points at this cask") is slightly ahead of reality until #2 lands. It degrades gracefully: the manual commands below it work today regardless.

Verification

  • Casks/fizzy.rb present in basecamp/homebrew-tap, token fizzy, version 4.0.0
  • sha256 for fizzy_4.0.0_darwin_arm64.tar.gz matches the release asset exactly
  • Archive layout matches the cask stanzas: fizzy at root, completions/fizzy.{bash,zsh,fish}

Summary by cubic

Update README to install Fizzy 4 via the basecamp/tap cask: brew install --cask basecamp/tap/fizzy. Removes stale 3.x formula guidance, notes macOS and Linux support, and clarifies RCs are only on Releases.

  • Migration
    • 3.x used the fizzy-cli formula from robzolkos/fizzy-cli; the tap now points to the cask and brew update may offer migration. If auto-migration is blocked, run: brew tap basecamp/tap, brew install --cask basecamp/tap/fizzy, brew uninstall --formula --force fizzy-cli, brew untap robzolkos/fizzy-cli. Installing by fully-qualified name auto-trusts the cask; no brew trust needed.

Written for commit 8ad8c34. Summary will update on new commits.

Review in cubic

v4.0.0 published Casks/fizzy.rb and fizzy.json to basecamp/homebrew-tap,
so the cask is now the primary Homebrew install path.

The previous text told new users to install the 3.x formula from
robzolkos/fizzy-cli, which breaks once that tap's formula is removed in
favour of tap_migrations.json. It also gated the cask command behind a
warning that it was not usable until 4 stable shipped, which it now is.

Adds the manual upgrade path for 3.x users, since Homebrew will not tap
a third-party tap without explicit trust and most users will land on the
manual route rather than the automatic migration.
Copilot AI review requested due to automatic review settings July 27, 2026 21:13
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 27, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README’s installation instructions to reflect Fizzy v4’s new Homebrew distribution via the basecamp/tap cask, and adds guidance for existing 3.x Homebrew users to migrate safely.

Changes:

  • Makes brew install --cask basecamp/tap/fizzy the primary Homebrew install path (macOS + Linux).
  • Replaces the stale RC/stable messaging with an explicit note that RCs are only available via GitHub Releases.
  • Documents a manual migration path for users coming from the old robzolkos/fizzy-cli formula.

Tip

If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md Outdated
Installing a cask by fully-qualified name records trust automatically
(brew prints "Trusted cask basecamp/tap/fizzy" and writes it to
trust.json), so the explicit brew trust line was a no-op.

The previous explanation also conflated two things: Homebrew declining
to auto-tap a third-party tap during migration, and trust being required
for a manual fully-qualified install. Only the former is true.
Copilot AI review requested due to automatic review settings July 27, 2026 21:20
robzolkos added a commit to robzolkos/homebrew-fizzy-cli that referenced this pull request Jul 27, 2026
Installing a cask by fully-qualified name records trust automatically,
so the explicit brew trust line was a no-op. Homebrew still suggests it
in the migration output, hence the note.

Matches basecamp/fizzy-cli#191.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread README.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found and verified against the latest diff

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="README.md">

<violation number="1" location="README.md:59">
P3: This sentence is written as a guaranteed migration path, but migration depends on local tap/trust state. Using unconditional wording here can leave stale or inaccurate upgrade guidance; consider phrasing it conditionally (for example, "may offer to migrate you") and avoid asserting the tap’s current state as always true.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread README.md
Fizzy 4 release candidates are available from [Releases](https://github.com/basecamp/fizzy-cli/releases).
Release candidates are not published to Homebrew. They are available from [Releases](https://github.com/basecamp/fizzy-cli/releases).

*Upgrading from Fizzy 3.x:* 3.x was distributed as the `fizzy-cli` formula from the `robzolkos/fizzy-cli` tap. That tap now points at this cask, so `brew update` will offer to move you across. If Homebrew reports that it cannot tap `basecamp/tap` automatically, finish the move yourself:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3: This sentence is written as a guaranteed migration path, but migration depends on local tap/trust state. Using unconditional wording here can leave stale or inaccurate upgrade guidance; consider phrasing it conditionally (for example, "may offer to migrate you") and avoid asserting the tap’s current state as always true.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 59:

<comment>This sentence is written as a guaranteed migration path, but migration depends on local tap/trust state. Using unconditional wording here can leave stale or inaccurate upgrade guidance; consider phrasing it conditionally (for example, "may offer to migrate you") and avoid asserting the tap’s current state as always true.</comment>

<file context>
@@ -48,22 +48,25 @@ Use `fizzy doctor` any time you want a full health check of your install, config
-Fizzy 4 release candidates are available from [Releases](https://github.com/basecamp/fizzy-cli/releases).
+Release candidates are not published to Homebrew. They are available from [Releases](https://github.com/basecamp/fizzy-cli/releases).
+
+*Upgrading from Fizzy 3.x:* 3.x was distributed as the `fizzy-cli` formula from the `robzolkos/fizzy-cli` tap. That tap now points at this cask, so `brew update` will offer to move you across. If Homebrew reports that it cannot tap `basecamp/tap` automatically, finish the move yourself:
+
+```bash
</file context>
Suggested change
*Upgrading from Fizzy 3.x:* 3.x was distributed as the `fizzy-cli` formula from the `robzolkos/fizzy-cli` tap. That tap now points at this cask, so `brew update` will offer to move you across. If Homebrew reports that it cannot tap `basecamp/tap` automatically, finish the move yourself:
*Upgrading from Fizzy 3.x:* 3.x was distributed as the `fizzy-cli` formula from the `robzolkos/fizzy-cli` tap. If your setup is eligible for migration, `brew update` may offer to move you across. If Homebrew reports that it cannot tap `basecamp/tap` automatically, finish the move yourself:

@robzolkos

Copy link
Copy Markdown
Collaborator Author

Resolved in #194

@robzolkos robzolkos closed this Jul 27, 2026
@jeremy
jeremy deleted the readme-homebrew-v4 branch July 27, 2026 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants