Add information about the CLI version to generated code. #2673
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
…module. Add insta filters for the version info in generated code.
gefjon
approved these changes
Apr 28, 2025
Contributor
gefjon
left a comment
gefjon
left a comment
There was a problem hiding this comment.
Note that we use the same build.rs-derived env!("GIT_HASH") mechanism for the CLI's spacetime version output. As such, I don't think we're hung up about build.rs potentially not rerunning.
Insta filtering seems to not be working, but once you fix that, this seems like an obvious win.
bfops
approved these changes
Apr 28, 2025
Collaborator
bfops
left a comment
bfops
left a comment
There was a problem hiding this comment.
My codeowned diff in crates/cli/src/version.rs LGTM.
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
1 task
13 tasks
joslynesser
added a commit
to joslynesser/nixpkgs
that referenced
this pull request
Aug 19, 2025
git directory needed by build.rs to set GIT_HASH at compile time for use in code generation and CLI version output see clockworklabs/SpacetimeDB#2673
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This updates the comments at the top of all the generated files to include the cargo version and git commit of the CLI used to generate the code. For typescript, it also adds the
cliVersionto theREMOTE_MODULE, so the typescript SDK will be able to reference it (which should be helpful for adding context to logs and eventually checking for version drift between the SDK and codegen versions).To avoid needing to update code snapshots constantly with
insta review, I added some filters to ignore the parts of generated code where we are inserting the version info.This isn't perfect, since
build.rsdoesn't always run when the current git commit changes, but releases should get the correct value (the existing--versionflag of the CLI has the same issue).There is a corresponding private PR to update CI checks.
API and ABI breaking changes
This doesn't change any APIs.
Expected complexity level and risk
Testing
This has testing in the snapshot, and I've also looked at the generated code.