Skip to content

docs(cli): document Homebrew tap trust for third-party tap installs#483

Merged
peteski22 merged 1 commit into
mainfrom
docs/brew-tap-trust
Jun 30, 2026
Merged

docs(cli): document Homebrew tap trust for third-party tap installs#483
peteski22 merged 1 commit into
mainfrom
docs/brew-tap-trust

Conversation

@peteski22

@peteski22 peteski22 commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

What

Adds a tap-trust note to cli/README.md (the canonical install doc referenced by README.md and DEVELOPMENT.md).

Why

Homebrew is moving to require explicit trust for non-official (third-party) taps — warnings now via brew doctor and install commands, enforced by default in Homebrew 6.0.0 or 5.2.0, whichever comes first. See docs.brew.sh/Tap-Trust.

Our documented command brew install --cask mozilla-ai/tap/cq is already fully-qualified, which trusts only the cq cask, so it keeps working untouched under tap trust. The note makes that explicit and documents the brew trust --cask path for users who brew tap first and install by short name. cq ships as a cask, so the short-name path uses --cask (not --formula).

No command was changed — this is documentation only.

Verification

  • Content checked against the live Homebrew Tap-Trust docs (not from memory).
  • Pre-commit hooks pass, including the docs link check.

Summary by CodeRabbit

  • Documentation
    • Updated the CLI installation guide with clearer Homebrew guidance for third-party taps.
    • Added a note explaining when extra trust steps may be needed, including an alternative install flow for the short cask name.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4638c8a3-0e77-4043-9019-e7478ab4da5c

📥 Commits

Reviewing files that changed from the base of the PR and between 12ad86d and e4bc7be.

📒 Files selected for processing (1)
  • cli/README.md

Walkthrough

Adds a note to cli/README.md explaining that mozilla-ai/tap is a third-party Homebrew tap, clarifying the fully-qualified cask install path, and giving an alternative brew tap plus brew trust installation sequence.

Changes

Homebrew Installation Docs

Layer / File(s) Summary
Homebrew tap trust guidance
cli/README.md
Inserts a note about third-party tap trust, explaining the existing fully-qualified cask install behaviour and adding an alternative brew tap, brew trust --cask mozilla-ai/tap/cq, then brew install --cask cq workflow.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation-only change about Homebrew tap trust for third-party CLI installs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/brew-tap-trust

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@cli/README.md`:
- Line 26: The Homebrew version timeline wording in the trust note is ambiguous
and should be clarified in the README text around the `mozilla-ai/tap/cq`
installation guidance. Update the sentence so it does not imply a conflicting
“whichever comes first” version expectation; either remove the speculative
release numbers entirely or rephrase them as an uncertain future release
example, keeping the guidance about `tap trust` and fully-qualified cask
installs intact.
- Around line 26-33: The Homebrew trust guidance in the README needs a minimum
version note because brew trust may not exist on older installs. Update the
Homebrew tap trust section in cli/README.md to mention the minimum Homebrew
version or supported release needed for brew trust, and if applicable add a
fallback path for users on older Homebrew versions. Keep the guidance aligned
with the existing brew tap, brew trust --cask, and brew install --cask cq
instructions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ee7dfee0-1dfc-4eb2-afe5-0c12023065c3

📥 Commits

Reviewing files that changed from the base of the PR and between 767d88b and 12ad86d.

📒 Files selected for processing (1)
  • cli/README.md

Comment thread cli/README.md Outdated
Comment thread cli/README.md Outdated
Homebrew will require explicit trust for non-official taps in a future
release (6.0.0 or 5.2.0, whichever comes first). The existing
'brew install --cask mozilla-ai/tap/cq' is fully-qualified and already
trusts only that cask, so it keeps working; this note makes that explicit
and documents 'brew trust --cask' for users who tap first and install by
short name.
@peteski22 peteski22 force-pushed the docs/brew-tap-trust branch from 12ad86d to e4bc7be Compare June 30, 2026 16:17
@peteski22 peteski22 merged commit ce8bf09 into main Jun 30, 2026
3 of 4 checks passed
@peteski22 peteski22 deleted the docs/brew-tap-trust branch June 30, 2026 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant