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.
99 lines
2.3 KiB
Markdown
99 lines
2.3 KiB
Markdown
---
|
|
title: "bd github"
|
|
description: "Commands for syncing issues between beads and GitHub."
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc github`.
|
|
|
|
Commands for syncing issues between beads and GitHub.
|
|
|
|
Configuration can be set via 'bd config' or environment variables:
|
|
github.token / GITHUB_TOKEN - Personal access token
|
|
github.owner / GITHUB_OWNER - Repository owner
|
|
github.repo / GITHUB_REPO - Repository name
|
|
github.repository / GITHUB_REPOSITORY - Combined "owner/repo" format
|
|
github.url / GITHUB_API_URL - Custom API URL (GitHub Enterprise)
|
|
|
|
```
|
|
bd github [flags]
|
|
```
|
|
|
|
## bd github pull
|
|
|
|
Pull one or more items from GitHub.
|
|
|
|
Accepts bead IDs or external references as positional arguments.
|
|
Equivalent to: bd github sync --pull-only --issues <refs>
|
|
|
|
```
|
|
bd github pull [refs...] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--dry-run Preview pull without making changes
|
|
```
|
|
|
|
## bd github push
|
|
|
|
Push one or more beads issues to GitHub.
|
|
|
|
Accepts bead IDs as positional arguments.
|
|
Equivalent to: bd github sync --push-only --issues <ids>
|
|
|
|
```
|
|
bd github push [bead-ids...] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--dry-run Preview push without making changes
|
|
```
|
|
|
|
## bd github repos
|
|
|
|
List GitHub repositories that the configured token has access to.
|
|
|
|
```
|
|
bd github repos [flags]
|
|
```
|
|
|
|
## bd github status
|
|
|
|
Display current GitHub configuration and sync status.
|
|
|
|
```
|
|
bd github status [flags]
|
|
```
|
|
|
|
## bd github sync
|
|
|
|
Synchronize issues between beads and GitHub.
|
|
|
|
By default, performs bidirectional sync:
|
|
- Pulls new/updated issues from GitHub to beads
|
|
- Pushes local beads issues to GitHub
|
|
|
|
Use --pull-only or --push-only to limit direction.
|
|
|
|
```
|
|
bd github sync [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--dry-run Show what would be synced without making changes
|
|
--issues string Comma-separated bead IDs to sync selectively (e.g., bd-abc,bd-def). Mutually exclusive with --parent.
|
|
--parent string Limit push to this bead and its descendants (push only). Mutually exclusive with --issues.
|
|
--prefer-github On conflict, use GitHub version
|
|
--prefer-local On conflict, keep local beads version
|
|
--prefer-newer On conflict, use most recent version (default)
|
|
--pull-only Only pull issues from GitHub
|
|
--push-only Only push issues to GitHub
|
|
```
|