Skip to content

Conversation

@bfops
Copy link
Collaborator

@bfops bfops commented Oct 14, 2025

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

  • CI passes
  • CI fails if I change the CLI reference
  • CLI reference looks visually reasonable on a local pnpm dev

@bfops bfops requested a review from cloutiertyler October 14, 2025 17:12
@bfops bfops marked this pull request as ready for review October 14, 2025 17:13
@bfops bfops added release-any To be landed in any release window no runtime change This change does not affect the final binaries labels Oct 20, 2025
@bfops bfops requested a review from jdetter October 20, 2025 16:41
Signed-off-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
@bfops bfops removed the request for review from jdetter November 18, 2025 20:41
@bfops bfops changed the title Add pnpm install step to docs CLI reference instructions Docs README - Add CLI instructions back and add pnpm install step Nov 18, 2025
@bfops bfops mentioned this pull request Dec 11, 2025
@bfops bfops requested a review from jdetter as a code owner December 15, 2025 19:02
@bfops bfops linked an issue Dec 15, 2025 that may be closed by this pull request
@bfops bfops changed the title Docs README - Add CLI instructions back and add pnpm install step Docs README - Add CLI instructions back Dec 15, 2025
@bfops bfops changed the title Docs README - Add CLI instructions back Fix CLI reference generation Dec 15, 2025
Copy link
Collaborator

@jdetter jdetter left a 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 👍

@bfops bfops enabled auto-merge December 16, 2025 17:42
@bfops bfops added this pull request to the merge queue Dec 16, 2025
Merged via the queue into master with commit f49945c Dec 16, 2025
41 of 42 checks passed
@bfops bfops deleted the bfops/pnpm-install-instruction branch December 17, 2025 18:31
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CI - Fix CLI docs step

3 participants