Document reproducibility and use of git - #35
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Expands the crate-level documentation in src/lib.rs to better explain how crate-git-revision behaves across different build environments (published crates vs. local git checkouts), with emphasis on reproducibility and CI safety.
Changes:
- Document when
GIT_REVISIONis intentionally left unset (no.cargo_vcs_info.jsonand no usablegit). - Clarify git-related expectations/behaviors (shallow clones, clean working tree for reproducibility).
- Document sanitization of path-redirecting
GIT_*env vars and the use ofGIT_TERMINAL_PROMPT=0to avoid hangs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
graydon
approved these changes
May 27, 2026
leighmcculloch
enabled auto-merge (squash)
May 27, 2026 03:48
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.
What
Expand the crate-level docs with sections covering builds without version info, shallow clone support, reproducible-build expectations around clean working trees, the stripping of path-redirecting
GIT_*env vars, and theGIT_TERMINAL_PROMPT=0behavior.Why
Surface behaviors that previously required reading the source: when
GIT_REVISIONstays unset, why CI environments settingGIT_DIR/GIT_WORK_TREEno longer leak into recorded revisions, and how in-place build steps can produce a spurious-dirtysuffix.