-
Notifications
You must be signed in to change notification settings - Fork 663
Fix CLI reference generation #3403
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.
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
Merged
Merged
Conversation
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
… reference instructions
Signed-off-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
pnpm install step to docs CLI reference instructionspnpm install step
Closed
…n/master' into bfops/pnpm-install-instruction
Closed
pnpm install step
bfops
commented
Dec 15, 2025
bfops
commented
Dec 15, 2025
bfops
commented
Dec 15, 2025
jdetter
reviewed
Dec 16, 2025
jdetter
approved these changes
Dec 16, 2025
Collaborator
jdetter
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, I tested this on windows via git bash:
boppy@geralt MINGW64 ~/clockwork/SpacetimeDB (bfops/pnpm-install-instruction)
$ cd docs/
boppy@geralt MINGW64 ~/clockwork/SpacetimeDB/docs (bfops/pnpm-install-instruction)
$ ./scripts/generate-cli-docs.mjs
And it seemed to update the line endings in the cli reference file:
boppy@geralt MINGW64 ~/clockwork/SpacetimeDB/docs (bfops/pnpm-install-instruction)
$ git status
On branch bfops/pnpm-install-instruction
Your branch is up to date with 'origin/bfops/pnpm-install-instruction'.
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: docs/00500-cli-reference/00100-cli-reference.md
When I add the file the changes go away which is expected. Thanks Zeke 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
no runtime change
This change does not affect the final binaries
release-any
To be landed in any release window
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.
Description of Changes
Add back the instructions for regenerating CLI docs, which were removed in #3343. I also made a script for it.
This also fixes the CI checking this file, which was silently broken in the same PR.
I have not verified that this works in Git Bash in Windows.
API and ABI breaking changes
None
Expected complexity level and risk
1
Testing
pnpm dev