git2-rs中使用commit_signed创建的签名提交未在仓库显示

常见原因及修复步骤 #

1. 未手动更新分支引用 #

commit_signed仅创建提交对象，不会自动将当前分支的HEAD指向新提交（普通commit方法内部会自动处理这一步）。必须手动更新分支引用：

// 创建签名提交后，手动将分支指向新提交
let branch = repo.find_branch("main", git2::BranchType::Local)?;
branch.set_target(new_commit.id(), "Signed commit")?;
repo.set_head("refs/heads/main")?;

2. 签名配置未正确加载或指定 #

git2不会自动读取全局/仓库gitconfig的签名密钥，需要手动获取或指定签名者信息：

// 从仓库配置中读取签名所需信息
let config = repo.config()?;
let name = config.get_string("user.name")?;
let email = config.get_string("user.email")?;
let sign_key = config.get_string("user.signingkey")?;

// 创建合法的签名者对象
let sig = git2::Signature::now(&name, &email)?;

3. 未显式确认提交写入状态 #

创建提交后，需确保索引和仓库状态被刷新，避免提交仅存在于内存中：

let new_commit = repo.commit_signed(
    None, // 不自动更新HEAD
    &sig, // 作者签名
    &sig, // 提交者签名
    "Signed commit message",
    &tree,
    &[&parent_commit],
    &sign_key,
)?;
// 写入索引并验证提交存在
repo.index()?.write()?;
repo.revparse_single(&format!("{}", new_commit.id()))?;

4. GPG环境未正确配置 #

git2依赖系统GPG环境，需确保：

• GPG_TTY环境变量已正确设置（比如export GPG_TTY=$(tty)）
• 签名密钥存在于当前用户的GPG密钥环中
• 自动执行场景下，密钥需无密码或已配置密码缓存

5. 忽略了错误处理 #

很多时候提交失败是因为密钥不存在、密码错误等，但错误被静默忽略。必须严格处理Result类型：

match repo.commit_signed(...) {
    Ok(commit) => {
        // 处理提交成功逻辑
    }
    Err(e) => {
        eprintln!("签名提交失败: {}", e);
        // 打印错误可直接定位问题，比如密钥未找到、权限不足等
    }
}

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