Jon Chery
b6dd86fdf3
- README: status banner v0.12+v0.13, latest tag v0.12.10, subcommand table expanded (auth/nft/peer-setup/secrets rotate-master), "mTLS by default" corrected to "SSH-push canonical", docs table updated - docs/cli.md: complete rewrite (521->1465 lines), all ~40 subcommands - CHANGELOG: regenerated from git log (v0.11.29..HEAD) - help text: job run HCL->markdown, job stop daemon->SSH-push - docs/security-runbook.md: expanded to match P05 reality (seal/unseal, doctor audit/modes/oidc, incident response) - docs/webauthn.md: added auth register (P06) - docs/namespace.md: added inherit + set-constraint - internal/proxmox/bootstrap.go: comments password->key auth - internal/cli/status.go: deprecation warning - scripts/verify-docs.sh + make verify-docs: cli.md <-> orca --help - cmd/verify-reqs/main.go: fix bold-format regex (was bypassing v0.12) + case-insensitive status matching - .ciagent/REQUIREMENTS.md: v0.12 REQs marked complete - .ciagent/ROADMAP.md: v0.12 bolded COMPLETE ---ci--- project: orca phase: 11 milestone: v0.13 status: complete requirements: covered: [160] ---/ci---
51 lines
1.7 KiB
Bash
Executable File
51 lines
1.7 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# verify-docs.sh — assert that every subcommand documented in docs/cli.md
|
|
# exists in `orca --help` output (and vice versa). Catches doc drift.
|
|
#
|
|
# Usage: scripts/verify-docs.sh [binary] [docs/cli.md]
|
|
# Exit 0 = consistent, 1 = drift detected, 2 = error.
|
|
set -euo pipefail
|
|
|
|
BIN="${1:-./bin/orca}"
|
|
DOCS="${2:-docs/cli.md}"
|
|
|
|
if [ ! -x "$BIN" ]; then
|
|
echo "verify-docs: binary not found at $BIN (run 'make build' first)" >&2
|
|
exit 2
|
|
fi
|
|
if [ ! -f "$DOCS" ]; then
|
|
echo "verify-docs: $DOCS not found" >&2
|
|
exit 2
|
|
fi
|
|
|
|
# Extract top-level commands from `orca --help` (lines indented under
|
|
# "Available Commands:" with two leading spaces, command name is the
|
|
# first token).
|
|
HELP_OUTPUT="$("$BIN" --help 2>/dev/null)"
|
|
HELP_CMDS="$(echo "$HELP_OUTPUT" | \
|
|
awk '/^Available Commands:/{flag=1; next} /^$/{flag=0} flag && /^ /{print $1}' | \
|
|
grep -v '^completion$' | grep -v '^help$' | sort -u)"
|
|
|
|
# Extract documented commands from docs/cli.md. These appear as
|
|
# `## \`orca <command>\`` or `## \`orca <command>\` *(deprecated)*` headers.
|
|
DOC_CMDS="$(grep -oE '^## `orca [a-z_-]+`' "$DOCS" | \
|
|
sed 's/^## `orca //; s/`$//' | sort -u)"
|
|
|
|
# Compare.
|
|
diff_out="$(diff <(echo "$HELP_CMDS") <(echo "$DOC_CMDS") || true)"
|
|
|
|
if [ -n "$diff_out" ]; then
|
|
echo "verify-docs: drift detected between docs/cli.md and \`orca --help\`:" >&2
|
|
echo "$diff_out" >&2
|
|
echo "" >&2
|
|
echo "Commands in --help but not in docs/cli.md (add them):" >&2
|
|
comm -23 <(echo "$HELP_CMDS") <(echo "$DOC_CMDS") >&2
|
|
echo "" >&2
|
|
echo "Commands in docs/cli.md but not in --help (remove them or fix typo):" >&2
|
|
comm -13 <(echo "$HELP_CMDS") <(echo "$DOC_CMDS") >&2
|
|
exit 1
|
|
fi
|
|
|
|
echo "verify-docs: OK — docs/cli.md consistent with orca --help"
|
|
exit 0
|