Why: regenerating CLI docs on a machine with a C compiler links CGO by
default, so `bd federation --help` emits the full federation subcommand tree.
The committed docs are built by CI with CGO_ENABLED=0, which stubs federation
("built without CGO support"), so a naive regen produces ~hundreds of lines of
spurious federation churn (federation.md, CLI_REFERENCE.md, llms-full.txt)
unrelated to the actual change. The existing guard force-rebuilds a pure-go
binary but offered no escape hatch and announced the swap on stdout.
What:
- Route the CGO-mismatch notice to stderr (keeps --check/CI stdout clean and
makes it a proper warning).
- Add a documented BD_DOCS_ALLOW_CGO=1 override hook so an intentional
full-federation regen can trust the supplied binary as-is; default stays
safe (rebuild pinned CGO_ENABLED=0 -tags gms_pure_go).
- Make the message name the pure-go recipe and reference the stub marker
("Federation commands require CGO", cmd/bd/federation_nocgo.go).
- Document the override in the script's --help text.
generate-llms-full.sh builds no bd binary, so it needs no change.
Agent-Signature: claude-opus-4-8-high on behalf of matt wilkie
168 lines
6.3 KiB
Bash
Executable file
168 lines
6.3 KiB
Bash
Executable file
#!/bin/bash
|
|
# generate-cli-docs.sh — Generate CLI reference docs from the live bd command tree.
|
|
|
|
set -euo pipefail
|
|
export LC_ALL=C
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
|
|
|
|
CHECK_MODE=0
|
|
VERSIONED_VERSION=""
|
|
BD_ARG=""
|
|
TMP_BUILD_DIR=""
|
|
TMP_OUTPUT_DIR=""
|
|
|
|
while [ "$#" -gt 0 ]; do
|
|
case "$1" in
|
|
--check)
|
|
CHECK_MODE=1
|
|
shift
|
|
;;
|
|
--versioned)
|
|
[ "$#" -ge 2 ] || { echo "Error: --versioned needs a version" >&2; exit 2; }
|
|
VERSIONED_VERSION="$2"
|
|
shift 2
|
|
;;
|
|
-h|--help)
|
|
cat <<'EOF'
|
|
Usage: scripts/generate-cli-docs.sh [--check] [--versioned VERSION] [path-to-bd]
|
|
|
|
Generate live CLI docs from one bd process. Historical Docusaurus snapshots are
|
|
left untouched unless --versioned VERSION is supplied by the release snapshot
|
|
workflow.
|
|
|
|
If the resolved bd binary is CGO-enabled it emits the full `bd federation` help
|
|
tree that CI (CGO_ENABLED=0) stubs out; the script rebuilds a pinned pure-go
|
|
binary to keep committed docs in sync. Set BD_DOCS_ALLOW_CGO=1 to bypass that
|
|
rebuild and trust the supplied binary as-is.
|
|
EOF
|
|
exit 0
|
|
;;
|
|
*)
|
|
if [ -n "$BD_ARG" ]; then
|
|
echo "Error: multiple bd binaries supplied: $BD_ARG and $1" >&2
|
|
exit 2
|
|
fi
|
|
BD_ARG="$1"
|
|
shift
|
|
;;
|
|
esac
|
|
done
|
|
|
|
cleanup() {
|
|
if [ -n "$TMP_BUILD_DIR" ]; then
|
|
rm -rf "$TMP_BUILD_DIR"
|
|
fi
|
|
if [ -n "$TMP_OUTPUT_DIR" ]; then
|
|
rm -rf "$TMP_OUTPUT_DIR"
|
|
fi
|
|
}
|
|
trap cleanup EXIT
|
|
|
|
if [ -n "$BD_ARG" ]; then
|
|
BD="$BD_ARG"
|
|
elif [ -x "$PROJECT_ROOT/bd" ]; then
|
|
BD="$PROJECT_ROOT/bd"
|
|
else
|
|
TMP_BUILD_DIR="$(mktemp -d)"
|
|
BD="$TMP_BUILD_DIR/bd"
|
|
echo "Building temporary bd for docs generation..."
|
|
(cd "$PROJECT_ROOT" && CGO_ENABLED=0 go build -tags gms_pure_go -o "$BD" ./cmd/bd/)
|
|
fi
|
|
|
|
# Guard against a CGO-enabled bd: it exposes the full `bd federation` subcommand tree
|
|
# that CI never produces (scripts/ci/pr-policy.sh build_docs_binary uses env
|
|
# CGO_ENABLED=0 go build). A CGO build therefore emits ~hundreds of lines of federation
|
|
# help that the committed, CI-built docs stub out ("built without CGO support"), so a
|
|
# naive regen on a machine with a C compiler produces spurious federation churn.
|
|
#
|
|
# The pure-go federation stub prints "Federation commands require CGO" (see
|
|
# cmd/bd/federation_nocgo.go); a CGO build does not. If the resolved binary is missing
|
|
# that stub marker, warn and rebuild a pinned CGO_ENABLED=0 -tags gms_pure_go binary so
|
|
# the committed docs always match CI. Set BD_DOCS_ALLOW_CGO=1 to bypass the rebuild and
|
|
# trust the supplied binary as-is (e.g. to deliberately regenerate the full federation
|
|
# tree); you then own any federation churn the diff introduces.
|
|
if [ -x "$BD" ] && ! "$BD" federation --help 2>&1 | grep -q "Federation commands require CGO"; then
|
|
if [ "${BD_DOCS_ALLOW_CGO:-0}" = "1" ]; then
|
|
echo "WARNING: $BD looks CGO-enabled and emits the full 'bd federation' help tree," >&2
|
|
echo " which CI's pure-go docs build stubs out. BD_DOCS_ALLOW_CGO=1 is set," >&2
|
|
echo " using it anyway; expect federation doc churn unless that is intended." >&2
|
|
else
|
|
echo "WARNING: $BD looks CGO-enabled; its 'bd federation' help differs from CI's" >&2
|
|
echo " pure-go build and would add spurious federation doc churn." >&2
|
|
echo " Rebuilding a pinned pure-go (CGO_ENABLED=0 -tags gms_pure_go) binary" >&2
|
|
echo " for CI-consistent docs. Set BD_DOCS_ALLOW_CGO=1 to use it as-is." >&2
|
|
if [ -z "$TMP_BUILD_DIR" ]; then
|
|
TMP_BUILD_DIR="$(mktemp -d)"
|
|
fi
|
|
BD="$TMP_BUILD_DIR/bd-pure"
|
|
(cd "$PROJECT_ROOT" && CGO_ENABLED=0 go build -tags gms_pure_go -o "$BD" ./cmd/bd/)
|
|
fi
|
|
fi
|
|
|
|
if [ ! -x "$BD" ]; then
|
|
echo "Error: bd binary not found or not executable: $BD" >&2
|
|
echo "Usage: $0 [--check] [--versioned VERSION] [path-to-bd]" >&2
|
|
exit 1
|
|
fi
|
|
|
|
generate_all() {
|
|
local root="$1"
|
|
local args=(help --docs-root "$root")
|
|
if [ -n "$VERSIONED_VERSION" ]; then
|
|
args+=(--docs-version "$VERSIONED_VERSION")
|
|
fi
|
|
"$BD" "${args[@]}"
|
|
}
|
|
|
|
if [ "$CHECK_MODE" -eq 1 ]; then
|
|
TMP_OUTPUT_DIR="$(mktemp -d)"
|
|
mkdir -p "$TMP_OUTPUT_DIR/website"
|
|
cp -Rf "$PROJECT_ROOT/website/docs" "$TMP_OUTPUT_DIR/website/docs"
|
|
if [ -d "$PROJECT_ROOT/website/versioned_docs" ]; then
|
|
cp -Rf "$PROJECT_ROOT/website/versioned_docs" "$TMP_OUTPUT_DIR/website/versioned_docs"
|
|
fi
|
|
if [ -f "$PROJECT_ROOT/website/versions.json" ]; then
|
|
cp -f "$PROJECT_ROOT/website/versions.json" "$TMP_OUTPUT_DIR/website/versions.json"
|
|
fi
|
|
|
|
generate_all "$TMP_OUTPUT_DIR"
|
|
|
|
if ! diff -qr \
|
|
"$PROJECT_ROOT/docs/CLI_REFERENCE.md" \
|
|
"$TMP_OUTPUT_DIR/docs/CLI_REFERENCE.md" >/dev/null; then
|
|
echo "FAIL: docs/CLI_REFERENCE.md is out of sync with live CLI help."
|
|
echo "Run: ./scripts/generate-cli-docs.sh ${BD_ARG:-}"
|
|
diff -u "$PROJECT_ROOT/docs/CLI_REFERENCE.md" "$TMP_OUTPUT_DIR/docs/CLI_REFERENCE.md" | sed -n '1,120p' || true
|
|
exit 1
|
|
fi
|
|
|
|
check_dirs=("website/docs/cli-reference")
|
|
if [ -n "$VERSIONED_VERSION" ]; then
|
|
check_dirs+=("website/versioned_docs/version-$VERSIONED_VERSION/cli-reference")
|
|
fi
|
|
|
|
for rel in "${check_dirs[@]}"; do
|
|
if [ -d "$PROJECT_ROOT/$rel" ]; then
|
|
if ! diff -qr "$PROJECT_ROOT/$rel" "$TMP_OUTPUT_DIR/$rel" >/dev/null; then
|
|
echo "FAIL: $rel is out of sync with live CLI help."
|
|
echo "Run: ./scripts/generate-cli-docs.sh ${BD_ARG:-}"
|
|
diff -ur "$PROJECT_ROOT/$rel" "$TMP_OUTPUT_DIR/$rel" | sed -n '1,160p' || true
|
|
exit 1
|
|
fi
|
|
fi
|
|
done
|
|
|
|
"$PROJECT_ROOT/scripts/generate-llms-full.sh" --check --source-root "$TMP_OUTPUT_DIR"
|
|
|
|
echo "PASS: generated CLI docs are fresh"
|
|
else
|
|
generate_all "$PROJECT_ROOT"
|
|
echo "Generated CLI docs from: $($BD version 2>/dev/null | head -1 || echo "$BD")"
|
|
if [ -n "$VERSIONED_VERSION" ]; then
|
|
echo "Updated docs/CLI_REFERENCE.md, website CLI reference pages, and version-$VERSIONED_VERSION CLI snapshot"
|
|
else
|
|
echo "Updated docs/CLI_REFERENCE.md and live website CLI reference pages"
|
|
fi
|
|
fi
|