导读:本期聚焦于小伙伴创作的《C#如何编写用于Git事件的C#脚本?pre-commit和post-receive钩子怎么实现》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《C#如何编写用于Git事件的C#脚本?pre-commit和post-receive钩子怎么实现》有用,将其分享出去将是对创作者最好的鼓励。

Git钩子是存放在仓库.git/hooks目录下的可执行脚本,Git会在特定事件触发时自动调用对应的钩子文件。C#本身不能直接作为脚本被Git直接执行,但可以通过编译为可执行程序,再让Git钩子脚本调用该C#程序的方式实现需求。

C#如何编写用于Git事件的C#脚本?pre-commit和post-receive钩子怎么实现

Git钩子基础说明

Git钩子分为客户端钩子和服务端钩子,pre-commit属于客户端钩子,在git commit命令执行前触发,常用于代码格式校验、单元测试执行等场景;post-receive属于服务端钩子,在远程仓库接收到推送请求后触发,常用于自动部署、通知推送结果等场景。

默认情况下.git/hooks目录下会有带.sample后缀的示例文件,去掉后缀并赋予可执行权限后就会生效。对于C#实现的钩子,我们只需要让钩子文件调用编译好的C#可执行程序即可。

编写pre-commit钩子的C#程序

pre-commit钩子的核心需求是校验当前提交的代码是否符合规范,如果不符合则阻止提交。首先我们编写一个C#控制台程序,实现获取暂存区文件、校验代码格式的逻辑。

C#程序实现

以下代码实现了一个简单的pre-commit校验程序,检查暂存区中的C#文件是否包含TODO注释,如果存在则输出错误并退出:

using System;
using System.Diagnostics;
using System.IO;
using System.Text;

class PreCommitChecker
{
    static int Main(string[] args)
    {
        // 执行git命令获取暂存区的C#文件列表
        var getStagedFilesProcess = new Process
        {
            StartInfo = new ProcessStartInfo
            {
                FileName = "git",
                Arguments = "diff --cached --name-only --diff-filter=ACM",
                RedirectStandardOutput = true,
                UseShellExecute = false,
                CreateNoWindow = true
            }
        };
        getStagedFilesProcess.Start();
        string stagedFilesOutput = getStagedFilesProcess.StandardOutput.ReadToEnd();
        getStagedFilesProcess.WaitForExit();

        var stagedFiles = stagedFilesOutput.Split(new[] { 'n', 'r' }, StringSplitOptions.RemoveEmptyEntries);
        bool hasError = false;

        foreach (var file in stagedFiles)
        {
            // 只处理.cs后缀的文件
            if (!file.EndsWith(".cs", StringComparison.OrdinalIgnoreCase))
                continue;

            if (!File.Exists(file))
                continue;

            string fileContent = File.ReadAllText(file, Encoding.UTF8);
            // 检查是否包含TODO注释
            if (fileContent.Contains("// TODO"))
            {
                Console.WriteLine($"错误:文件 {file} 包含未处理的TODO注释,请处理后再提交");
                hasError = true;
            }
        }

        if (hasError)
        {
            // 返回非0退出码,Git会阻止本次提交
            return 1;
        }

        Console.WriteLine("pre-commit校验通过");
        return 0;
    }
}

钩子脚本配置

将上面的C#程序编译为PreCommitChecker.exe,放到仓库根目录下。然后进入.git/hooks目录,创建名为pre-commit的文件(无后缀),内容如下:

#!/bin/sh
# 调用C#编译的可执行程序
exec "$(git rev-parse --show-toplevel)/PreCommitChecker.exe"

如果是Windows系统,也可以将钩子文件命名为pre-commit.bat,内容如下:

@echo off
"%~dp0..PreCommitChecker.exe"

给钩子文件赋予可执行权限后,每次执行git commit时就会自动触发校验逻辑。

编写post-receive钩子的C#程序

post-receive钩子在服务端执行,常用于推送后的自动操作,比如拉取最新代码部署、发送推送通知等。下面实现一个简单的post-receive程序,输出本次推送的分支和提交信息。

C#程序实现

post-receive会从标准输入读取推送的旧引用、新引用和分支信息,以下代码实现读取这些信息并输出:

using System;
using System.IO;

class PostReceiveHandler
{
    static void Main(string[] args)
    {
        Console.WriteLine("收到推送请求,开始处理post-receive逻辑");

        // post-receive从标准输入读取推送信息,每行格式为:旧引用 新引用 分支名
        string inputLine;
        while ((inputLine = Console.ReadLine()) != null)
        {
            if (string.IsNullOrWhiteSpace(inputLine))
                continue;

            var parts = inputLine.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
            if (parts.Length != 3)
                continue;

            string oldRef = parts[0];
            string newRef = parts[1];
            string branch = parts[2].Replace("refs/heads/", "");

            Console.WriteLine($"分支:{branch}");
            Console.WriteLine($"旧引用:{oldRef}");
            Console.WriteLine($"新引用:{newRef}");

            // 这里可以添加自动部署、发送通知等自定义逻辑
            // 例如调用部署脚本、请求通知接口等
        }

        Console.WriteLine("post-receive处理完成");
    }
}

钩子脚本配置

将C#程序编译为PostReceiveHandler.exe,放到服务端仓库的.git/hooks目录下。创建名为post-receive的钩子文件,内容如下:

#!/bin/sh
exec "$(dirname "$0")/PostReceiveHandler.exe"

当开发者向该远程仓库推送代码时,服务端就会自动执行这个C#程序,处理后续的自定义逻辑。

常见问题说明

  • 钩子脚本需要保证可执行权限,Linux/macOS系统可以通过chmod +x .git/hooks/pre-commit命令赋予权限。
  • C#程序需要编译为对应平台的可执行文件,服务端如果是Linux系统,需要使用.NET Core及以上版本编译跨平台程序。
  • 钩子程序的退出码很重要,pre-commit返回非0会直接阻止提交,post-receive的退出码不影响推送结果,但建议返回0表示执行成功。
  • 如果钩子执行失败,可以通过查看Git输出的错误信息排查问题,也可以在C#程序中添加日志输出到文件方便调试。

C#Git钩子pre-commitpost-receive脚本编写修改时间:2026-07-16 18:18:30

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。