基于Libgit2实现git pull --rebase后HEAD与master分支分离问题

我用Libgit2实现git pull --rebase功能，代码执行无报错，但调用git_rebase_finish()后，HEAD指针与master分支分离，HEAD领先于master分支，无法定位问题所在。

代码实现 #

error = git_repository_open( &repo, "/tmp/varloc" );
cout << error << endl;
error = git_remote_lookup( &remote, repo, "origin" );
cout << error << endl;
error = git_remote_fetch( remote, NULL, &fetch_options, NULL );
cout << error << endl;
error = git_repository_fetchhead_foreach(repo, fetchhead_ref_cb, &id_to_merge);
cout << error << endl;
error = git_annotated_commit_lookup(&heads, repo, &id_to_merge);
cout << error << endl;
error = git_repository_head(&head, repo);
cout << error << endl;
error = git_annotated_commit_from_ref(&onto, repo, head);
cout << error << endl;
error = git_rebase_init(&rebase, repo, (const git_annotated_commit *)heads, NULL, onto, &rebase_options);
cout << error << endl;
error = git_signature_now(&me, "Free", "pr070@riseup.net");
cout << error << endl;
while((error = git_rebase_next(&op, rebase)) == 0){
    error = git_rebase_commit(&rebaseOID, rebase, NULL, me, NULL, NULL);
}
error = git_rebase_finish(rebase, me);
cout << error << endl;
git_libgit2_shutdown();
return 0;
}

Git日志信息 #

commit 4bc03c76474aa0fce8c90ca99f9839eb64f3a67c (HEAD)
Author: FreedomCoder <pr070cryp70n1c@riseup.net>
Date:   Sun Jul 17 22:12:48 2022 +0000

    Add 'tgb'

commit 6ef02ad62c5795d847499452118e38d94013b378 (master)
Author: FreedomCoder <pr070cryp70n1c@riseup.net>
Date:   Sun Jul 17 21:25:46 2022 +0000

    Add 'rfv'

问题分析与解决 #

核心问题 #

你的代码完成了rebase的变基操作，但没有更新本地master分支的指向。git pull --rebase的完整流程不仅要将本地提交变基到远程分支，还要把本地分支指针（这里是master）同步到变基后的HEAD位置，否则就会出现HEAD游离且领先于master的情况。

修复步骤 #

1. 更新master分支指向变基后的HEAD
   在git_rebase_finish()执行成功后，添加代码将master分支的引用指向当前HEAD的OID：

error = git_rebase_finish(rebase, me);
cout << error << endl;

// 新增：同步master分支到变基后的HEAD
if (error == 0) {
    git_oid head_oid;
    error = git_repository_head_id(&head_oid, repo);
    if (error == 0) {
        git_reference *master_ref;
        error = git_reference_lookup(&master_ref, repo, "refs/heads/master");
        if (error == 0) {
            git_reference *updated_ref;
            // 更新master分支指向变基后的提交
            error = git_reference_set_target(&updated_ref, master_ref, &head_oid, "rebase: update master to rebased HEAD");
            git_reference_free(updated_ref);
            git_reference_free(master_ref);
        }
    }
}

2. 修正rebase初始化参数
   你当前的git_rebase_init参数中，onto使用了本地HEAD的提交，这不符合git pull --rebase的逻辑。正确的git pull --rebase等价于git fetch + git rebase origin/master，因此upstream和onto都应该设置为远程origin/master的最新提交（也就是你从fetchhead拿到的id_to_merge）：

// 移除原有生成onto的代码
// error = git_repository_head(&head, repo);
// error = git_annotated_commit_from_ref(&onto, repo, head);

// 直接将onto设置为远程提交的annotated commit
error = git_rebase_init(&rebase, repo, heads, NULL, heads, &rebase_options);

3. 完善循环错误判断
   在git_rebase_next的循环中，应该判断循环结束的标志是GIT_ITEROVER，避免忽略其他错误：

while(true) {
    error = git_rebase_next(&op, rebase);
    if (error == GIT_ITEROVER) {
        // 变基步骤完成
        break;
    } else if (error != 0) {
        // 处理错误
        cerr << "Rebase next error: " << error << endl;
        goto cleanup;
    }
    error = git_rebase_commit(&rebaseOID, rebase, NULL, me, NULL, NULL);
    if (error != 0) {
        cerr << "Rebase commit error: " << error << endl;
        goto cleanup;
    }
}

最终效果 #

完成上述修改后，执行代码后master分支会同步到变基后的HEAD位置，不会再出现游离HEAD的情况，与git pull --rebase的原生行为一致。

内容的提问来源于stack exchange，提问作者FreedomCoder