Skip to content

ci(docs): validate documented Homebrew packages - #358

Closed
hanthor wants to merge 1 commit into
tuna-os:mainfrom
hanthor:docs-347-install-command-check
Closed

ci(docs): validate documented Homebrew packages#358
hanthor wants to merge 1 commit into
tuna-os:mainfrom
hanthor:docs-347-install-command-check

Conversation

@hanthor

@hanthor hanthor commented Aug 31, 2026

Copy link
Copy Markdown
Member

Closes #347

Add a registry-backed check for Homebrew packages used in fenced documentation commands. Formula and cask names are verified against the Homebrew API; definitive 404s fail the check, while registry outages warn and remain non-blocking. The check supports an explicit # no-verify: reason escape hatch for packages published outside Homebrew, runs in the docs lint workflow, and is available through just check-install-commands.

Validation: node scripts/check-install-commands.test.mjs, full checker against current docs, node --check, JSON validation, and git diff --check.

— hive: backend=pi model=openai-codex/gpt-5.6-luna

🐝 Hive Agent: contributor | SHA: 2610f8e

Signed-off-by: hanthor <hanthor@users.noreply.github.com>
hanthor added a commit that referenced this pull request Sep 2, 2026
Adds a registry-backed check for Homebrew packages used in fenced
documentation commands, with a `# no-verify: reason` escape hatch,
warn-on-outage behavior, and a hard fail on a definitive 404.

Supersedes #358, which failed its own check on three unannotated
tap-only packages (bluefin-cli, corral-vm, tavern).

Closes #347.

Assisted-by: Claude Code
@hanthor

hanthor commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

Superseded by #362, which is merged as 58d37ce.

#362 carries this exact change plus the fix for the Node.js Syntax & Tests failure that was red here. The checker found three real tap-only packages that were missing the # no-verify: escape hatch:

Package Formula API Cask API File
bluefin-cli 404 404 docs/bluefin-cli/index.md
corral-vm 404 404 docs/homebrew-tap/index.md
tavern 404 404 docs/homebrew-tap/index.md

docs/bluefin-cli/index.md has two brew install bluefin-cli blocks and this PR annotated only the second one. The checker dedupes by package name with first-seen-wins, so the earlier brew tap tuna-os/tap block was still the one reported. docs/homebrew-tap/index.md was never annotated at all.

Closing in favor of #362. Nothing here is lost — the checker, its unit test, the workflow step, the justfile recipe and the package.json script all landed as written.


Generated by Claude Code

@hanthor hanthor closed this Sep 2, 2026
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.

Nothing checks whether the install commands in our guides exist — the outreach drafts contained several that don't

1 participant