ci(cli): publish ts docs reference - #6253
Open
7ttp wants to merge 4 commits into
Open
Conversation
7ttp
changed the title
Contributor
Supabase CLI previewnpx --yes https://pkg.pr.new/supabase/cli/supabase@da7b4c453fa384fc410925a31d5c82e1f34d4d14Preview package for commit |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 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".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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?
docsjob 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-docbranch in supabase/supabase and opens a PR when none is open..cli/ref-docalready exists the new spec lands as a commit on top, so fixes pushed onto an open bot PR survive later releaseshow?
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-docand opens thefamiliar
chore: update cli reference docPR for the docs team to mergea stable dry run exercises the same pipe with
--dry-run, which also verifies the App token mint without pushing anything.will follow up on
supabase/supabasewith a spec-to-sidebar coverage guard,so a new command missing a
common-cli-sections.jsonentry fails the bot PR instead of silently publishing no page...ref: