Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix checking git submodules during a commit hook #126255

Merged
merged 1 commit into from
Jun 17, 2024
Merged

fix checking git submodules during a commit hook #126255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 17 additions & 20 deletions src/bootstrap/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,19 +520,20 @@ impl Build {
return;
}

// check_submodule
let checked_out_hash =
output(helpers::git(Some(&absolute_path)).args(["rev-parse", "HEAD"]));
// update_submodules
let submodule_git = || helpers::git(Some(&absolute_path));
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left this closure in since I think it makes the code more readable to abstract this common call away.


// Determine commit checked out in submodule.
let checked_out_hash = output(submodule_git().args(["rev-parse", "HEAD"]));
let checked_out_hash = checked_out_hash.trim_end();
// Determine commit that the submodule *should* have.
let recorded =
output(helpers::git(Some(&self.src)).args(["ls-tree", "HEAD"]).arg(relative_path));
let actual_hash = recorded
.split_whitespace()
.nth(2)
.unwrap_or_else(|| panic!("unexpected output `{}`", recorded));

// update_submodule
if actual_hash == checked_out_hash.trim_end() {
if actual_hash == checked_out_hash {
// already checked out
return;
}
Expand Down Expand Up @@ -581,26 +582,22 @@ impl Build {
// Save any local changes, but avoid running `git stash pop` if there are none (since it will exit with an error).
// diff-index reports the modifications through the exit status
let has_local_modifications = !self.run_cmd(
BootstrapCommand::from(helpers::git(Some(&absolute_path)).args([
"diff-index",
"--quiet",
"HEAD",
]))
.allow_failure()
.output_mode(match self.is_verbose() {
true => OutputMode::PrintAll,
false => OutputMode::PrintOutput,
}),
BootstrapCommand::from(submodule_git().args(["diff-index", "--quiet", "HEAD"]))
.allow_failure()
.output_mode(match self.is_verbose() {
true => OutputMode::PrintAll,
false => OutputMode::PrintOutput,
}),
);
if has_local_modifications {
self.run(helpers::git(Some(&absolute_path)).args(["stash", "push"]));
self.run(submodule_git().args(["stash", "push"]));
}

self.run(helpers::git(Some(&absolute_path)).args(["reset", "-q", "--hard"]));
self.run(helpers::git(Some(&absolute_path)).args(["clean", "-qdfx"]));
self.run(submodule_git().args(["reset", "-q", "--hard"]));
self.run(submodule_git().args(["clean", "-qdfx"]));

if has_local_modifications {
self.run(helpers::git(Some(&absolute_path)).args(["stash", "pop"]));
self.run(submodule_git().args(["stash", "pop"]));
}
}

Expand Down
10 changes: 10 additions & 0 deletions src/bootstrap/src/utils/helpers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,16 @@ pub fn git(source_dir: Option<&Path>) -> Command {

if let Some(source_dir) = source_dir {
git.current_dir(source_dir);
// If we are running inside git (e.g. via a hook), `GIT_DIR` is set and takes precedence
// over the current dir. Un-set it to make the current dir matter.
git.env_remove("GIT_DIR");
// Also un-set some other variables, to be on the safe side (based on cargo's
// `fetch_with_cli`). In particular un-setting `GIT_INDEX_FILE` is required to fix some odd
// misbehavior.
git.env_remove("GIT_WORK_TREE")
.env_remove("GIT_INDEX_FILE")
.env_remove("GIT_OBJECT_DIRECTORY")
.env_remove("GIT_ALTERNATE_OBJECT_DIRECTORIES");
}

git
Expand Down
Loading