Files
Chris Sells d2f87d50de docs(pipeline): pin the CLI docs to the released bd; repair main's broken CLI reference (#4876)
* docs(pipeline): pin the generated CLI docs to the released bd; repair main's CLI reference

The #4874 squash-merge raced the docs-autofix bot: the bot had pushed a
regeneration from main's source onto the PR branch, so the squash landed a
contradictory mix — the release-aligned hand-written docs plus a CLI
reference re-documenting unreleased commands and flags, with docs.json
referencing four pages (heartbeat, migrate-personal, reclaim, unclaim)
whose files do not exist. That broken nav fails the docsync guard on main
and on every branch cut from it. This restores the intended end state of
#4874 and lands the pin that prevents the race from recurring.

- Regenerate the CLI reference from a bd built from the v1.1.0 tag (CI's
  canonical pure-Go build), removing the unreleased commands/flags and
  fixing the dangling nav entries.
- docs/cli-docs.pin names the release tag; scripts/resolve-docs-bd.sh
  builds and caches a canonical pure-Go bd from that tag, fetching the tag
  first in shallow CI checkouts.
- generate-cli-docs.sh, check-doc-flags.sh, and check-cli-docs-drift.sh
  resolve bd through the pin and ignore a supplied binary while pinned
  (BD_DOCS_IGNORE_PIN=1 bypasses), so the drift gates and the autofix bot
  now enforce docs-match-release instead of docs-match-main.
- tools/docsmint detects the pre-overhaul Docusaurus staging layout that
  bd <= v1.1.0 emits and converts it to the generic form before its normal
  Mintlify transform (tested); removable once the pin reaches a release
  whose emitter writes build/cli-docs.
- check-doc-flags.sh: run without timeout(1) on macOS instead of failing
  Check 4.
- Decision record: engdocs/decisions/2026-07-17-docs-release-pin.md; the
  beads-docs skill §8 updated to match.

* lint: annotate gosec G705 false positive in the docsmint legacy bridge

Same class as the existing nav-splice annotation: a developer tool writing
repo Markdown, not a web-output sink.
2026-07-17 18:03:28 -07:00

1.7 KiB

title, description
title description
bd upgrade Commands for checking bd version upgrades and reviewing changes.

{/* AUTO-GENERATED: do not edit manually */}

Generated from bd help --doc upgrade.

Commands for checking bd version upgrades and reviewing changes.

The upgrade command helps you stay aware of bd version changes:

  • bd upgrade status: Check if bd version changed since last use
  • bd upgrade review: Show what's new since your last version
  • bd upgrade ack: Acknowledge the current version

Version tracking is automatic - bd updates metadata.json on every run.

bd upgrade [flags]

bd upgrade ack

Mark the current bd version as acknowledged.

This updates metadata.json to record that you've seen the current version. Mainly useful after reviewing upgrade changes to suppress future upgrade notifications.

Note: Version tracking happens automatically, so you don't need to run this command unless you want to explicitly mark acknowledgement.

Examples: bd upgrade ack bd upgrade ack --json

bd upgrade ack [flags]

bd upgrade review

Show what's new in bd since the last version you used.

Unlike 'bd info --whats-new' which shows the last 3 versions, this command shows ALL changes since your specific last version.

If you're upgrading from an old version, you'll see the complete changelog of everything that changed since then.

Examples: bd upgrade review bd upgrade review --json

bd upgrade review [flags]

bd upgrade status

Check if bd has been upgraded since you last used it.

This command uses the version tracking that happens automatically at startup to detect if bd was upgraded.

Examples: bd upgrade status bd upgrade status --json

bd upgrade status [flags]