如何使用Libgit2sharp获取远程分支文件实现推送前校验

这个需求完全可实现，不需要额外调用原生Git命令，直接通过LibGit2Sharp内置API即可完成校验，不会破坏本地工作区状态，性能开销很低。

核心实现逻辑 #

整个校验流程分三步：

• 定向拉取目标远程分支的最新引用，不需要全量拉取整个仓库所有分支内容
• 判断目标远程分支是否存在，不存在则直接判定为空分支，允许推送
• 若分支存在，遍历分支最新提交的目录树，排查是否存在README之外的其他条目，存在则拦截推送

参考实现代码 #

using LibGit2Sharp;

// 初始化本地仓库实例
using var repo = new Repository("你的本地仓库存储路径");
// 配置目标远程、待校验分支名
const string remoteName = "origin";
const string targetRemoteBranch = "main"; // 替换为实际要推送的目标分支名
var remote = repo.Network.Remotes[remoteName];

// 配置拉取认证，根据自己的认证方式调整（SSH/账号密码/Token）
var fetchOptions = new FetchOptions
{
    CredentialsProvider = (_, _, _) => new UsernamePasswordCredentials
    {
        Username = "你的Git账号名",
        Password = "你的Git访问令牌/密码"
    }
};

// 仅拉取目标远程分支的最新数据，不会改动本地工作区
Commands.Fetch(repo, remote.Name, new[] { $"refs/heads/{targetRemoteBranch}" }, fetchOptions, "");

// 拿到远程分支实例
var targetBranch = repo.Branches[$"{remote.Name}/{targetRemoteBranch}"];

// 分支不存在，说明远程无对应内容，直接放行
if (targetBranch == null)
{
    // 执行后续推送逻辑
    return;
}

// 遍历分支最新提交的根目录条目，判断是否存在非README文件
var isBlocked = false;
foreach (var entry in targetBranch.Tip.Tree)
{
    // 匹配所有常见README文件（忽略大小写，支持README、README.md、README.txt等格式）
    var isReadmeFile = entry.Name.StartsWith("README", StringComparison.OrdinalIgnoreCase);
    if (!isReadmeFile)
    {
        isBlocked = true;
        break;
    }
}

if (isBlocked)
{
    throw new Exception("目标远程分支已存在非README内容，禁止推送本地文件夹至该分支");
}

// 校验通过，执行后续推送逻辑

适配调整提示 #

• 要是你需要把所有子目录的文件都纳入校验，把上面遍历根目录的逻辑改成递归遍历所有子树节点就行，一般场景下查根目录就够拦绝大多数误推的情况
• README的匹配规则可以自己改，比如你们业务只认根目录的README.md，就把开头匹配改成精确匹配文件名即可
• 定向拉取只会拿目标分支的必要数据，不会自动合并到本地分支，也不会改动本地未提交的修改，不用担心搞乱工作区

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