ci: wire post-process-cli-docs.js into CLI docs update workflow#4866
Open
lennessyy wants to merge 3 commits into
Open
ci: wire post-process-cli-docs.js into CLI docs update workflow#4866lennessyy wants to merge 3 commits into
lennessyy wants to merge 3 commits into
Conversation
gen-docs (temporalio/cli#1112) stopped emitting the ReleaseNoteHeader banner on cloud CLI pages, assuming this script would add it back, but the workflow never actually called it. Run it after regenerating the command reference so the banner, index.mdx, and sidebars.js stay in sync.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview linksThis PR does not change any pages in /docs. If you make updates, links to the modified pages will appear here. |
…tion gen-docs never emitted that banner, in any version; the script has had that job since it was created, CI just never called it.
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.
Summary
bin/post-process-cli-docs.jsinjects theReleaseNoteHeaderbanner into cloud CLI pages and keepscommand-reference/index.mdxandsidebars.jsin sync with the generated commands.update-cli-docs.ymldidn't call it, so the banner and index/sidebar updates only happened on past regens where someone ran the script locally before committing. Since the docs went through the workflow without it (#4864), the banner is missing from the cloud CLI pages it produced.This adds a step that runs the script right after the generated docs are copied in and the hand-maintained index files are restored, and before the result is committed.
Test plan
update-cli-docs.ymlrun (or a manualworkflow_dispatch) produces cloud CLI pages withReleaseNoteHeaderpresentdocs/cli/command-reference/index.mdxandsidebars.jsstay consistent with the generated command set