Libs(Rust): track sources produced by codegen in git #1598
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
Motivated by the desire to simplify the build/release for this SDK and the CLI. Additionally, tracking codegen files in the Go SDK has proven helpful for us in the past as our spec has evolved. Having these sources tracked as well can give us a "second opinion" when changes bubble up. A similar problem as seen in the Go SDK exists for any other that tracks their codegen sources in git; stale files have to be explicitly removed. Previously this would happen naturally when starting from a clean working copy, but no longer. To avoid a build up of sources that are orphaned by spec changes, the regen script now deletes files before generating new ones. Svix maintainers take note: action is required in this situation. Look for the removals by checking `git status` then stage the deletions before pushing your commit up!
Merged
tasn
approved these changes
Dec 31, 2024
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.
Motivated by the desire to simplify the build/release for this SDK and the CLI.
Additionally, tracking codegen files in the Go SDK has proven helpful for us in the past as our spec has evolved. Having these sources tracked as well can give us a "second opinion" when changes bubble up.
A similar problem as seen in the Go SDK exists for any other that tracks their codegen sources in git; stale files have to be explicitly removed. Previously this would happen naturally when starting from a clean working copy, but no longer. To avoid a build up of sources that are orphaned by spec changes, the regen script now deletes files before generating new ones.
Svix maintainers take note: action is required in this situation. Look for the removals by checking
git statusthen stage the deletions before pushing your commit up!