mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document the new git logic in more detail

Browse Source 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
This commit is contained in:
onur-ozkan 2024-09-10 20:06:35 +03:00
parent 0a7f9e2134
commit 5f32717649
2 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/tools/build_helper/src/git.rs
View File

@ -96,7 +96,14 @@ pub fn updated_master_branch(
Err("Cannot find any suitable upstream master branch".to_owned())
}
fn get_git_merge_base(config: &GitConfig<'_>, git_dir: Option<&Path>) -> Result<String, String> {
/// Finds the nearest merge commit by comparing the local `HEAD` with the upstream branch's state.
/// To work correctly, the upstream remote must be properly configured using `git remote add <name> <url>`.
/// In most cases `get_closest_merge_commit` is the function you are looking for as it doesn't require remote
/// to be configured.
fn git_upstream_merge_base(
config: &GitConfig<'_>,
git_dir: Option<&Path>,
) -> Result<String, String> {
let updated_master = updated_master_branch(config, git_dir)?;
let mut git = Command::new("git");
if let Some(git_dir) = git_dir {
@ -105,9 +112,10 @@ fn get_git_merge_base(config: &GitConfig<'_>, git_dir: Option<&Path>) -> Result<
Ok(output_result(git.arg("merge-base").arg(&updated_master).arg("HEAD"))?.trim().to_owned())
}
/// Resolves the closest merge commit by the given `author` and `target_paths`.
/// Searches for the nearest merge commit in the repository that also exists upstream.
///
/// If it fails to find the commit from upstream using `git merge-base`, fallbacks to HEAD.
/// If it fails to find the upstream remote, it then looks for the most recent commit made
/// by the merge bot by matching the author's email address with the merge bot's email.
pub fn get_closest_merge_commit(
git_dir: Option<&Path>,
config: &GitConfig<'_>,
@ -119,7 +127,7 @@ pub fn get_closest_merge_commit(
git.current_dir(git_dir);
}
let merge_base = get_git_merge_base(config, git_dir).unwrap_or_else(|_| "HEAD".into());
let merge_base = git_upstream_merge_base(config, git_dir).unwrap_or_else(|_| "HEAD".into());
git.args([
"rev-list",

7
src/tools/compiletest/src/lib.rs
View File

@ -164,7 +164,12 @@ pub fn parse_config(args: Vec<String>) -> Config {
.optopt("", "edition", "default Rust edition", "EDITION")
.reqopt("", "git-repository", "name of the git repository", "ORG/REPO")
.reqopt("", "nightly-branch", "name of the git branch for nightly", "BRANCH")
.reqopt("", "git-merge-commit-email", "email address used for the merge commits", "EMAIL");
.reqopt(
"",
"git-merge-commit-email",
"email address used for finding merge commits",
"EMAIL",
);
let (argv0, args_) = args.split_first().unwrap();
if args.len() == 1 || args[1] == "-h" || args[1] == "--help" {