Replace current_dir().unwrap() in init() with env::var_os("CARGO_MANIFEST_DIR") - #34
Merged
Conversation
leighmcculloch
marked this pull request as ready for review
May 26, 2026 04:45
There was a problem hiding this comment.
Pull request overview
This PR improves the clarity of failures in crate_git_revision::init() by replacing a bare unwrap() on std::env::current_dir() with an expect(...) message, and adds documentation explaining why relying on the current working directory is correct when invoked from a Cargo build script.
Changes:
- Replace
current_dir().unwrap()withcurrent_dir().expect("getting current directory")ininit(). - Add an in-function comment (with a Cargo reference link) describing Cargo’s working-directory guarantee for build scripts.
- Update the public rustdoc for
init()to describe the working-directory requirement (but it currently describes it imprecisely).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mootz12
approved these changes
May 26, 2026
graydon
approved these changes
May 27, 2026
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
Replace
current_dir().unwrap()ininit()withenv::var_os("CARGO_MANIFEST_DIR"), and document why this is the correct source of the crate path in a build script.Why
current_dir()happens to equal the manifest directory in the common case, butpackage.buildinCargo.tomlcan point to a build script located outside the package source tree.CARGO_MANIFEST_DIRis the env var Cargo explicitly sets to the package's manifest directory when executing the build script, so it's the correct source for the crate path regardless of where the build script lives.Using
expectinstead ofunwrapalso surfaces a clear message at the panic site. Under normal operations there is no reason forCARGO_MANIFEST_DIRto be unset — Cargo always sets it for build scripts. If it is unset, the build system is already broken in other, larger, disastrous ways, and graceful handling here would not meaningfully recover the build.Some discussion: