Skip to content

ci(cli): publish ts docs reference (CLI-2171) - #6253

Merged
7ttp merged 7 commits into
developfrom
chore/publish-cli-reference
Aug 24, 2026
Merged

ci(cli): publish ts docs reference (CLI-2171)#6253
7ttp merged 7 commits into
developfrom
chore/publish-cli-reference

Conversation

@7ttp

@7ttp7ttp commented Aug 18, 2026

Copy link
Copy Markdown
Member

TL;DR

fixes the CLI docs reference being frozen at v2.98.2
which was caused by the monorepo merge deleting the Go bumpdoc docs job from the release workflow,
and is now fixed by a stable-only docs job that regenerates the spec from the TS command tree and delivers it to supabase/supabase the same way bumpdoc did...

whats introduced?

  • a docs job in release.yml: stable releases only, runs after publish, non-blocking for the release, and mints the same scoped App token...
  • scripts/publish-docs-spec.ts: reads the generated spec on stdin, validates it
    (clispec 001, version match, command count) before any network action, formats it with a pinned prettier to match the published file's style, then updates the cli/ref-doc branch in supabase/supabase and opens a PR when none is open..
  • bumpdoc's append semantics: when cli/ref-doc already exists the new spec lands as a commit on top, so fixes pushed onto an open bot PR survive later releases
  • 6 integration tests for the publisher's refusal and dry-run paths, plus a README release section describing the automated flow

how?

stable release now runs generate-docs-spec.ts "$VERSION" | publish-docs-spec.ts --version "$VERSION"
which lands a validated, formatted spec as a commit on cli/ref-doc and opens the
familiar chore: update cli reference doc PR for the docs team to merge

Note

will follow up on supabase/supabase with a spec-to-sidebar coverage guard,
so a new command missing a common-cli-sections.json entry fails the bot PR instead of silently publishing no page...

ref:

@7ttp
7ttp requested a review from a team as a code ownerAugust 18, 2026 21:11
@7ttp7ttp self-assigned this Aug 18, 2026
@7ttp7ttp changed the title ci(cli): restore cli reference publishingci(cli): publish ts docs referenceAug 18, 2026
@github-actions

github-actionsBot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Supabase CLI preview

npx --yes https://pkg.pr.new/supabase/cli/supabase@afa50414ccde59ef506f08155421a4d306ecf651

Preview package for commit afa5041.

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:573b364862

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment threadapps/cli/scripts/publish-docs-spec.ts
Comment threadapps/cli/scripts/publish-docs-spec.e2e.test.ts
Comment threadapps/cli/scripts/publish-docs-spec.ts Outdated
Comment threadapps/cli/scripts/publish-docs-spec.ts Outdated
@7ttp
7ttp requested review from avallete and jgouxAugust 19, 2026 08:52
…i-reference
# Conflicts:
#	apps/cli/package.json
#	pnpm-lock.yaml
@7ttp
7ttp added this pull request to the merge queueAug 24, 2026
Merged via the queue into develop with commit b9254dfAug 24, 2026
16 checks passed
@7ttp
7ttp deleted the chore/publish-cli-reference branch August 24, 2026 09:30
@7ttp7ttp changed the title ci(cli): publish ts docs referenceci(cli): publish ts docs reference (CLI-2171)Aug 24, 2026
avallete pushed a commit that referenced this pull request Aug 28, 2026
gofmt -l flagged pkg/config/db.go and pkg/function/deploy_test.go
(pre-existing whitespace drift from #6253); fixed so the Go CI format check
stays green on branches touching apps/cli-go.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BQAoY9JF4uiZRvKVkSd9Wy
Sign up for freeto 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.

2 participants

@7ttp@Coly010