Skip to content

feat(docs): generate Commands section of README from cobra metadata #765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ewanharris wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat(docs): generate Commands section of README from cobra metadata #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a9c5b54
feat(docs): generate Commands section of README from cobra metadata
ewanharris Sep 18, 2026
e850c80
feat(docs): address reviewer findings — ordering, Long, group flags, …
ewanharris Oct 9, 2026
66dca59
feat(docs): reorder commands to match SDK canonical order
ewanharris Oct 8, 2026
3bd0be7
docs: regenerate README against rebased main
ewanharris Oct 8, 2026
738e117
feat(docs): address Copilot review findings
ewanharris Oct 8, 2026
14547d9
fix(lint): move cobra import to external group in gendocs/main.go
ewanharris Oct 8, 2026
a100620
feat(docs): add docs metadata for mapping evaluate command
ewanharris Oct 9, 2026
100137c
feat(docs): add docs metadata for mapping sync command
ewanharris Oct 9, 2026
4050294
Merge branch 'main' into worktree-feat+generate-commands-docs
ewanharris Oct 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/main.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ jobs:
- name: Run tests
run: make test

- name: Check README commands section is up to date
run: make generate-docs && git diff --exit-code README.md

shellcheck:
name: Shellcheck
runs-on: ubuntu-latest
Expand Down
6 changes: 5 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ $(MOCK_DIR)/client.go: $(GO_BIN)/mockgen $(MOCK_SRC_DIR)
#-----------------------------------------------------------------------------------------------------------------------
# Phony Rules(https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html)
#-----------------------------------------------------------------------------------------------------------------------
.PHONY: build run clean test lint audit format
.PHONY: build run clean test lint audit format generate-docs

help: ## Show this help
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
Expand Down Expand Up @@ -118,3 +118,7 @@ format: $(GO_BIN)/gofumpt ## Format Go source files

generate-mocks: $(MOCK_DIR)/*.go ## Generate Go mocks
@echo "==> Mocks generated"

generate-docs: ## Regenerate the Commands section of README.md from cobra command metadata
@echo "==> Generating docs"
@go run ./cmd/gendocs
Loading
Loading