git hooks 简介与使用

git hooks，即git 钩子，定义为能在特定的重要动作发生时触发自定义脚本。

git 的hook分为两种，客户端hooks和服务端hooks。

客户端钩子由诸如提交和合并这样的操作所调用，而服务器端钩子作用于诸如接收被推送的提交这样的联网操作。

官方文档：

git hooks在git项目中的位置在 /.git/hooks 目录下，初始化时由以下sample组成：

完整说明详见官方文档：

扩展参考：Jenkins+Gitlab通过脚本自动部署回滚web项目至集群

1）:Gitlab服务器：ubuntu 192.168.152.131 ---参考搭建：Linux安装gitlab，docker安装gitlab教程

2）:Jenkins服务器：ubunu 192.168.152.130 ---参考搭建：linux安装Jenkins，或docker安装Jenkins教程

在服务器上生成ssh-keygen，用于配置web服务器和Gitlab服务器。

3）:web服务器：centos 192.168.152.150 ---已搭建好LNMP环境

4）:开发者电脑：Windows+key密钥 （用于提交代码）

1：在gitlab创建项目Test Project

2.1）： 配置一个开发者电脑的ssh公钥到gitlab

配置一个开发者电脑的ssh公钥到gitlab，这样才能模拟开发上传代码到gitlab。

windows生成key过程及git安装，可参考：Windows下git和github的使用图文详细教程_the丶only的博客-CSDN博客_github win

在windows测试clone，和提交代码。

注：最新版git 已经将默认分支master改为main了。所以看到main，而不是master不要太奇怪

测试成功，在gitlab也显示有index.html文件。

2.2）： 配置jenkins公钥到gitlab

同理，同样需要jenkins公钥，因为jenkins也需要拉去gitlab的代码。

在 jenkins服务器 上查看公钥并复制添加到gitlab，并命名为jekins。

1：插件管理，安装插件

jenkins本身没什么功能，主要是依靠插件来实现各种强大的功能。

基本需要添加的插件：Gitlab Hook、Build Authorization Token Root、Publish Over SSH、Gitlab Authentication、Gitlab、Git Parameter

可以在 Manage Jenkins >> Manage Plugins 查看管理插件。在Available 选项搜索安装插件即可。

安装完成后，重启Jenkins。

2：添加需要部署的web主机

在 Manage Jenkins >> Configure System 中往下翻，找到 Publish over SSH 选项，点击add ssh server。

在Jenkins服务器上，查看私钥，注，是私钥，不是公钥。

将私钥填写在key位置，还有添加web服务器相关信息。

注：如果测试报错如下

Failed to connect or change directory

jenkins.plugins.publish_over.BapPublisherException: Failed to add SSH key. Message [invalid privatekey: [B@2e54414f]

是因为默认用ssh-keygen命令，默认生成了OPENSSH 格式密钥。而Jenkins暂时不支持这种私钥，私钥开头结尾如下：

所以，需要生成rsa密钥格式的。用开头说的ssh-keygen加其他参数生成即可。

私钥开头结尾如下：

再次测试，显示success，则成功。然后点击save保存即可。

3：构建任务项目

首页创建任务或者一个项目

命名为web-project，选择为freestyle project 自由项目。然后ok确认。

3.1）：源码管理 Source Code Management

选择源码管理，添加gitlab的项目clone地址。

注：最后路径选择分支，我gitlab主分支名字为main,如果是master，则写master，或者合并的其他分支。

在add添加用户

添加完成后，选择git用户，这时没有红色提醒，说明已成功连接

3.2）：构建触发器 Build Triggers

现在Build Triggers，勾选build when....，其他默认，并记下链接 http://192.168.152.130:8080/project/web-project

点击高级 advance 选项。

勾选filter branches regex选择，填写分支，生产token。其他默认

3.3）：构建 Build

选择Build 选项。选择ssh

添加web服务器

添加完毕，最后save保存。

1：添加钩子webhooks.

选择自己的项目Test Project，在设置setting里，选择钩子webhooks.

填写刚才记下的http://192.168.152.130:8080/project/web-project和token值。

最后Add webhook完成：

2：如添加失败，报错，更改Network

注：如填写失败提示Url is blocked: Requests to the local network are not allowed

还需更改Network选项。

3：测试钩子

添加完成后，下面会出现钩子选择。点击test中的，push event。

出现successful，即添加成功。

在Jenkins也可以看到刚才的测试时间信息。

在开发电脑上测试提交，我这里为Windows电脑测试。

打开Git Bash，输入以下命令：

提交成功，回到Jenkins，查看是否构建成功：

绿色显示构建成功，无错误显示。回到gitlab查看项目。

时间显示刚才也提交成功，无错误。最后在浏览器输入web地址测试，本人配置了web访问端口8082。所以输入IP加端口访问。

内容也已经自动更新成功。

完结撒花！！！

版本控制，这是现代软件开发的核心需求之一。有了它，软件项目可以安全的跟踪代码变更并执行回溯、完整性检查、协同开发等多种操作。在各种版本控制软件中，Git是近年来最流行的软件之一，它的去中心化架构以及源码变更交换的速度被很多开发者青睐。

在git的众多优点中，最有用的一点莫过于它的灵活性。通过“hooks”（钩子）系统，开发者和管理员们可以指定git在不同事件、不同动作下执行特定的脚本。

下面将介绍git hooks的基本思路以及用法，示范如何在你的环境中实现自动化的任务。本文所用的操作系统是Ubuntu 14.04服务器版，理论上任何可以跑git的系统都可以用同样的方法来做。

前提条件

首先你的服务器上先要安装过git。其次你应该能够进行基本的git操作。

Git Hooks的基本思路

Githooks的概念相当简单，它是为了一个单一需求而被设计实现的。在一个共享项目（或者说多人协同开发的项目）的开发过程中，团队成员需要确保其编码风格的统一，确保部署方式的统一，等等（git的用户经常会涉及到此类场景），而这些工作会造成大量的重复劳动。

Githooks是基于事件的（event-based）。当你执行特定的git指令时，该软件会从git仓库下的hooks目录下检查是否有相对应的脚本，如果有则执行之。

有些脚本是在动作执行之前被执行的，这种“先行脚本”可用于实现代码规范的统一、完整性检查、环境搭建等功能。有些脚本则在事件之后被执行，这种“后行脚本”可用于实现代码的部署、权限错误纠正（git在这方面的功能有点欠缺）等功能。

总体来说，git hooks可以实现策略强制执行、确保一致性、环境控制、部署任务处理等多种功能。

Scott Chacon在他的Pro Git一书中将hooks划分为如下类型：

客户端的hook：此类hook在提交者（committer）的计算机上被调用执行。此类hook又分为如下几类：代码提交相关的工作流hook、Email相关工作流hook、其他类：包括代码合并、签出（check out）、rebase、重写（rewrite）、以及软件仓库的清理等工作。

服务器端hook：此类hook作用在服务器端，一般用于接收推送，部署在项目的git仓库主干（main）所在的服务器上。Chacon将服务器端hook分为两类：接受触发类、更新类hook。

上述分类有助于我们对hook建立一个整体的概念，了解它可以用于哪类事件。当然了，要能够实际的运用它，还需要亲自动手操作、调试。

---