(don't review, just testing CI) by jonathantanmy2 · Pull Request #14524 · gitbutlerapp/gitbutler

jonathantanmy2 · 2026-06-29T22:54:24Z

Switch the rebase engine to use it. All other uses will be switched in future PRs.

Most tests in crates/but-core/tests/core/worktree/checkout.rs were switched to the new function too, to increase test coverage.

Copilot

Pull request overview

This PR introduces new libgit2-based checkout helpers in but-core, switches the rebase materialization path to use the new checkout entrypoint, and updates many worktree checkout tests accordingly. It also adjusts the workspace merge-base override computation used for “consumed hunks” and pins git2 to a specific git revision with an additional feature flag.

Changes:

Added checkout_tree, checkout_commit, and checkout_unconflicted_commit helpers and re-exported them from but_core::worktree.
Switched rebase materialization checkout from safe_checkout_from_head to checkout_tree.
Updated many worktree checkout tests to use the new checkout helpers; updated git2 dependency source/feature.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
crates/but-workspace/src/commit/mod.rs	Simplifies merge-base override computation used for checkout baselines derived from consumed changes.
crates/but-rebase/src/graph_rebase/materialize.rs	Switches rebase materialization to use the new `checkout_tree` function.
crates/but-core/tests/core/worktree/checkout.rs	Migrates several tests from `safe_checkout` to the new checkout helpers and updates assertions accordingly.
crates/but-core/src/worktree/mod.rs	Re-exports newly added checkout helpers from the worktree module.
crates/but-core/src/worktree/checkout/function.rs	Adds new checkout helper functions backed by libgit2.
Cargo.toml	Enables an additional `git2` feature and patches `git2` to a specific git revision.
Cargo.lock	Updates lockfile entries for `git2` / `libgit2-sys` to match the git-sourced patch.

-        head_update: "Update refs/heads/main to Some(Object(Sha1(31ec8eacfba4051fd673e4fe23c775e87896a463)))",
-    }
-    "#);
+    checkout_commit(&repo, head_commit.id, Some(empty_tree))?;


    assert_eq!(
        err.to_string(),
-        "Uncommitted files would be overwritten by checkout: \"file\"",
+        "1 conflict prevents checkout; class=Checkout (20); code=Conflict (-13)",
        "we check for conflict markers, and fail."
    );


+        // given baseline. We also need it to pretend that the index is the
+        // given baseline. That is not possible with the current API, so for
+        // now, write to the index to make it the given baseline.
+        git2_repo.index()?.read_tree(&baseline)?;


+    let mut opts = git2::build::CheckoutBuilder::new();
+    if let Some(ref baseline) = baseline {


+    commit: gix::ObjectId,
+    baseline_treeish: Option<gix::ObjectId>,
+) -> anyhow::Result<()> {
+    let new_object = commit.attach(repo).object()?;


-            Ok(spec)
-        })
-        .collect();
+    let mut specs: Vec<_> = consumed.into_iter().map(Ok).collect();


                    // If the head has changed (which means it's in the
                    // commit mapping), perform a safe checkout.
-                    safe_checkout_from_head(
-                        new_head,
-                        &repo,
-                        Options {
-                            skip_head_update: true,
-                            merge_base_override,
-                            allow_conflicted_commit_checkout: true,
-                        },
-                    )?;
+                    checkout_tree(&repo, new_head, merge_base_override)?;
                }


Copilot

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.

+    let git2_repo = git2::Repository::open(repo.git_dir())?;
+    let baseline = if let Some(baseline_treeish) = baseline_treeish {
+        let baseline = git2_repo
+            .find_object(baseline_treeish.to_git2(), None)?
+            .peel_to_tree()?;
+        // libgit2 only pretends that HEAD's tree (and not the index) is the
+        // given baseline. We also need it to pretend that the index is the
+        // given baseline. That is not possible with the current API, so for
+        // now, write to the index to make it the given baseline.
+        git2_repo.index()?.read_tree(&baseline)?;
+        Some(baseline)
+    } else {
+        None
+    };


+    let err = checkout_commit(&repo, new_commit.id, Some(head_commit.id)).unwrap_err();
    assert_eq!(
        err.to_string(),
-        "Uncommitted files would be overwritten by checkout: \"file\"",
+        "1 conflict prevents checkout; class=Checkout (20); code=Conflict (-13)",
        "we check for conflict markers, and fail."
    );


-    "#);
+    checkout_commit(&repo, new_commit.id, None)?;

    // Nothing changed as the checkout was aborted.


 [patch.crates-io]
 # Keep workspace crates that use the `gix 0.84` line on the same git revision.
 gix = { git = "https://github.com/GitoxideLabs/gitoxide", rev = "66f70f3063724b4145b21c6691c4f57892c7a74e" }
+git2 = { git = "https://github.com/jonathantanmy2/git2-rs", rev = "9e2ec81c8d37ba5142e5fb97c5afbc2f43c6d7eb" }


Switch the rebase engine to use it. All other uses will be switched in future PRs. Most tests in crates/but-core/tests/core/worktree/checkout.rs were switched to the new function too, to increase test coverage.

Copilot

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated 5 comments.

Comments suppressed due to low confidence (1)

crates/but-api/src/branch.rs:936

PR description says only the rebase engine is switched and that other call sites will be migrated in future PRs, but this change also migrates the branch checkout API path (and this PR touches multiple other non-rebase call sites). Consider updating the PR description/splitting the change so the scope matches what reviewers/CI expectations are based on.

        checkout_tree(&repo, target, Some(current_head)).with_context(|| {
            format!(
                "Could not safely check out '{}' from {current_head} to {target}",
                reference_name.as_bstr()
            )

+        // given baseline. We also need it to pretend that the index is the
+        // given baseline. That is not possible with the current API, so for
+        // now, write to the index to make it the given baseline.
+        git2_repo.index()?.read_tree(&baseline)?;


+/// Update the index and working directory (but not any refs). If
+/// `baseline_treeish` is None, `HEAD^{tree}` is used instead.


    assert_eq!(
        err.to_string(),
-        "Uncommitted files would be overwritten by checkout: \"file\"",
+        "1 conflict prevents checkout; class=Checkout (20); code=Conflict (-13)",
        "we check for conflict markers, and fail."
    );


-    "#);
+    checkout_commit(&repo, new_commit.id, None)?;

    // Nothing changed as the checkout was aborted.


 #[test]
 fn checkout_handles_directory_and_file_replacements() -> anyhow::Result<()> {
-    if but_testsupport::gix_testtools::is_ci::cached() {
-        // TODO(gix): remove this once `gitoxide` unconditional reset/checkout is available.
-        // Fails on checkout on CI Linux as it can't deal with `file`.
-        // Probably the `git2` OS error code handling isn't working cross-platform?
-        eprintln!("SKIPPING TEST KNOWN TO FAIL ON CI ONLY");
-        return Ok(());
-    }
    let (repo, _tmp) = writable_scenario("merge-with-two-branches-line-offset");


Copilot AI review requested due to automatic review settings June 29, 2026 22:54

jonathantanmy2 requested review from Byron, Caleb-T-Owens, estib-vega and krlvi as code owners June 29, 2026 22:54

github-actions Bot added the rust Pull requests that update Rust code label Jun 29, 2026

Copilot started reviewing on behalf of jonathantanmy2 June 29, 2026 22:54 View session

Copilot AI reviewed Jun 29, 2026

View reviewed changes

jonathantanmy2 force-pushed the jt/checkout branch from 1219d73 to 902666a Compare June 29, 2026 23:01

Copilot AI review requested due to automatic review settings June 29, 2026 23:33

jonathantanmy2 force-pushed the jt/checkout branch from 902666a to a713bdd Compare June 29, 2026 23:33

Copilot started reviewing on behalf of jonathantanmy2 June 29, 2026 23:33 View session

Copilot AI reviewed Jun 29, 2026

View reviewed changes

jonathantanmy2 force-pushed the jt/checkout branch from a713bdd to 26d078d Compare July 1, 2026 14:17

jonathantanmy2 added 3 commits July 1, 2026 10:12

checkout: safe checkout with libgit2

144fe29

Switch the rebase engine to use it. All other uses will be switched in future PRs. Most tests in crates/but-core/tests/core/worktree/checkout.rs were switched to the new function too, to increase test coverage.

deleted some tests

279c461

misc small parts

c1c9324

Copilot AI review requested due to automatic review settings July 1, 2026 17:15

jonathantanmy2 force-pushed the jt/checkout branch from 26d078d to c1c9324 Compare July 1, 2026 17:15

Copilot started reviewing on behalf of jonathantanmy2 July 1, 2026 17:16 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(don't review, just testing CI)#14524

(don't review, just testing CI)#14524
jonathantanmy2 wants to merge 3 commits into
masterfrom
jt/checkout

jonathantanmy2 commented Jun 29, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		let mut opts = git2::build::CheckoutBuilder::new();
		if let Some(ref baseline) = baseline {

		/// Update the index and working directory (but not any refs). If
		/// `baseline_treeish` is None, `HEAD^{tree}` is used instead.

Uh oh!

Conversation

jonathantanmy2 commented Jun 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants