Skip to content

Add cd-update-cli-docs workflow#11080

Open
tbantle22 wants to merge 1 commit into
mainfrom
add-cli-docs-update-workflow
Open

Add cd-update-cli-docs workflow#11080
tbantle22 wants to merge 1 commit into
mainfrom
add-cli-docs-update-workflow

Conversation

@tbantle22

Copy link
Copy Markdown
Contributor

On Dolt release: published (or manual workflow_dispatch), builds the released dolt, runs dolt dump-docs --file cli.md, and opens a PR against dolthub/docs-2:dev replacing site/dolt/src/content/reference/cli/cli.md (skips prereleases, no-ops if the regenerated file matches what's already there).

Triggers on `release: published` (and supports manual `workflow_dispatch`
for backfills). Checks out dolt at the release tag, builds the binary,
runs `dolt dump-docs --file /tmp/cli.md`, then checks out dolthub/docs-2
on the `dev` branch, replaces `site/dolt/src/content/reference/sql/...
/cli.md`, pushes a branch named `auto-update-cli-docs-v$VERSION`, and
opens a PR against `dev`. Skips prereleases. Exits cleanly without
opening an empty PR if the regenerated cli.md matches what's already
in docs-2.

Smoke-tested locally: `go build ./cmd/dolt` followed by `dolt dump-docs`
produces a 3007-line cli.md with 72 subcommand sections (matching the
shape of docs-2's current cli.md).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant