fix: move proto code generation output to OUT_DIR, out of tree#1703
Draft
fix: move proto code generation output to OUT_DIR, out of tree#1703
OUT_DIR, out of tree#1703Conversation
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
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.
Motivation
It's considered bad practice to commit bad practice to commit generated files into the source tree, the decision predates me.
We're effectively dropping 10k from our codebase and avoid a little friction on changes in protobuf.
Any decent editor that's using rust-analyzer can resolve
include!directives, so the location isn't relevant anymore.Note
We have a bit of machinery built around the proto generation, so I kept the integration bits by using the
generated/mod.rsto pull inconcat!(env!(OUT_DIR), "/generated/..*")files. The main purpose is to minimize the already gigantic changeset and avoid having to adapt import paths across the repository.Open Questions
While this is desirable in principle, it implies
Side effects
We are effectively dropping the special casing of
docs.rsbuilds based onBUILD_PROTO=1