mirror of
https://github.com/gastownhall/beads.git
synced 2026-09-14 20:17:24 +08:00
Chris Sells
d2f87d50de
* 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.
64 lines
1.1 KiB
Markdown
64 lines
1.1 KiB
Markdown
---
|
|
title: "bd comments"
|
|
description: "View or manage comments on an issue."
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc comments`.
|
|
|
|
View or manage comments on an issue.
|
|
|
|
Examples:
|
|
# List all comments on an issue (issue id is required — there is no "comments list")
|
|
bd comments bd-123
|
|
|
|
# List comments in JSON format
|
|
bd comments bd-123 --json
|
|
|
|
# Add a comment
|
|
bd comments add bd-123 "This is a comment"
|
|
|
|
# Add a comment from a file
|
|
bd comments add bd-123 -f notes.txt
|
|
|
|
```
|
|
bd comments [issue-id] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--local-time Show timestamps in local time instead of UTC
|
|
```
|
|
|
|
## bd comments add
|
|
|
|
Add a comment to an issue.
|
|
|
|
Examples:
|
|
# Add a comment
|
|
bd comments add bd-123 "Working on this now"
|
|
|
|
# Add a comment from a file
|
|
bd comments add bd-123 -f notes.txt
|
|
|
|
```
|
|
bd comments add [issue-id] [text] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
-a, --author string Add author to comment
|
|
-f, --file string Read comment text from file
|
|
```
|
|
|
|
## bd comments list
|
|
|
|
Invalid — use bd comments <issue-id> to list comments
|
|
|
|
```
|
|
bd comments list [flags]
|
|
```
|