sui: limit when the build script needs to be run #2026
Merged
Conversation
This file contains 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
Support for embedding the git revision inside the wallet cli was added back in 96611e0 (wallet: log git revision on start, 2022-04-22). This was done by using a build.rs file to run a few git commands to query for the git revision of HEAD and if the working directory was dirty or not. The addition of this feature had the unintended consequence of causing a ton of code to be re-build anytime any file in the `sui` crate was changed. This is due to the fact that, by default, a build.rs file is re-run anytime any file anywhere in the crate (integration tests and examples included) [1]. This patch fixes this by only having cargo re-run the build script when the build.rs file is changed. [1] https://doc.rust-lang.org/cargo/reference/build-scripts.html#cargorerun-if-changedpath
|
Hmm, but that's not what we want, is it? We want build.rs to always run in order to fetch the current git revision, right? |
|
Hmm, ok, for release builds (which are clean) this shouldn't impact anything. I think this could potentially cause us to get a bad git rev in a build but that's hardly the end of the world. |
mystenmark
approved these changes
May 18, 2022
|
yeah its really hard to do this is completely fool-proof way. I suppose another option would be to use a proc-macro like https://docs.rs/git-version/latest/git_version/ instead of a build script and query it just from the binary (that way when the binary is recompiled it properly picks up the correct version. |
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.
Support for embedding the git revision inside the wallet cli was added
back in 96611e0 (wallet: log git revision on start, 2022-04-22). This
was done by using a build.rs file to run a few git commands to query for
the git revision of HEAD and if the working directory was dirty or not.
The addition of this feature had the unintended consequence of causing
a ton of code to be re-build anytime any file in the
suicrate waschanged. This is due to the fact that, by default, a build.rs file is
re-run anytime any file anywhere in the crate (integration tests and
examples included) [1].
This patch fixes this by only having cargo re-run the build script when
the build.rs file is changed.
[1] https://doc.rust-lang.org/cargo/reference/build-scripts.html#cargorerun-if-changedpath