利用 GitHook 构建持续交付和部署

原文地址：https://blog.coding.net/blog/GitHook-for-delivery-and-deployment

一、为何要打造可持续交付和部署

软件发布是一个使人头痛的过程，很是耗时且风险很高。对于小团队来讲通常分为两种：“签入时交付”和“定时交付”。

“签入时交付”策略的优点在于立刻产生的知足感。根据代码库的规模，从签入新功能代码到可以在交付准备服务器上测试，一两分钟就够了。

这种方式的主要问题在于：交付准备服务器会被蹂躏得不稳定。不少时候，我见到有人试图测试某个功能，忽然新的版本推到交付准备服务器上了，破坏了正在运行的测试。更糟糕的是：交付准备服务器经常做为演示服务器使用，在某些重要的演示时，极可能出现严重的后果。

按期交付策略更易于预测。全部人都知道交付什么时候启动，并能够规划本身的代码签入是在交付以前仍是以后进行。典型作法是一天构建/交付一次或两次。

因为架构的特殊性，服务器将会愈来愈多。试想一下你要在几十台服务器上更新代码是一件多么繁琐的事情。对于咱们公司来讲面临着严重的如何更快交付和部署代码的问题。

咱们须要将经历过测试的代码可以迅速部署到服务器上，原本考虑过jekins，但jekins对咱们来讲又太过繁琐。

二、交付与部署过程

目前咱们使用的是阿里云服务，阿里云服务有个很方便的地方就是镜像，一次制做整个集群均可以使用。

工程师将代码上传到开发环境的库中，经过GitHook自动让测试用的服务器更新代码，测试完成后只要将相关的代码稍稍修改成生产环境的配置并上传到生产环境的Git库，经过GitHook全部与这个库有关的服务器都会自动更新代码。

测试的具体过程就不在此论述了。

三、GitHook

咱们来看下官方解释：

钩子(hooks)是一些在"$GIT-DIR/hooks"目录的脚本, 在被特定的事件(certain points)触发后被调用。当"git init"命令被调用后, 一些很是有用的示例钩子文件(hooks)被拷到新仓库的hooks目录中; 可是在默认状况下这些钩子(hooks)是不生效的。 把这些钩子文件(hooks)的".sample"文件名后缀去掉就可使它们生效了。

简单地来讲有点相似回调，就是特定事情完成后回调执行事件。

四、如何搭建

咱们公司使用的是coding、服务器上是已经装好jetty的ubuntu，不过github、gitlab跟这个的配置方法相似。

Git-SSH

首先如今coding上创建一个代码库，而后在生产环境上的代码部署的地方git clone刚刚新建的代码库。

没有git的要安装git，ubuntu下是apt-get install git

为了让git可以自动更新代码库而不须要输入帐号密码，这时候就须要用到git-ssh了。

若是是第一次使用要先设置git的名字和邮箱（本身随便取个名字和邮箱就行）：

git config --global user.name "test"

git config --global user.email "test@zomake.com"

而后经过上一个命令输入的邮箱来生成密钥

ssh-keygen -t rsa -C "test@zomake.com"

若是不须要设置密钥的密码的话，直接三个回车。而后你就在命令行上看到生成了两个文件：id_rsa和id_rsa.pub。

（若是不是第一次的话执行命令会提示overwrite，输入y就行。）

而后咱们把密钥交给ssh-agent来管理，能够经过eval "$(ssh-agent -s)" 看看是否是正常运行，是的话会输出它的pid。

ssh-add ~/.ssh/id_rsa

用上面这个命令将刚刚生成的私钥交给ssh-agent。路径填你在终端上看到的。

登陆coding，点击帐户-SSH公钥-添加。将以前生成的id_rsa.pub里的内容复制进去。

最后进到以前clone下来的代码库中修改.git文件夹下config中的url，改成远端仓库的SSH访问地址，如git@git.coding.net:t-baby/test.git

这样一来在服务器上git就无需输入帐号密码了。

准备update.sh

cd /vi git_update.sh

而后将下面的东西复制进去并保存：

#!/bin/bash

cd /opt/jetty/webapps

git remote update -p

git checkout -f origin/master

git submodule update --init

service jetty restart

第二行和最后一行根据须要自行更换，由于咱们的代码是Java的，放在jetty中运行。将第二行的cd改为你本身的代码所在目录。而最后一行代码是用来重启jetty服务器的，你能够去掉或加上本身服务器的重启代码。

保存后给这个脚本文件777的权限。

准备githook.php

因为一些缘由，为了方便咱们使用了php做为GitHook回调的地址。

先装好PHP环境并修改端口为8080，apache默认文件夹为/var/www（80已经被jetty占了，具体安装方法见我另外一篇文章）

在/var/www/中新建一个叫githook.php，而后放入如下代码：

shell_exec('cd /var/www && php gitpull.php');

而后再在当前文件夹下建个gitpull.php

$pid = pcntl_fork();
if ($pid == -1){
} else if ($pid > 0){
$fs = fopen('./git_hook.log', 'a');

fwrite($fs, 'Request on ['.date("Y-m-d H:i:s").']'.PHP_EOL);

$json = file_get_contents('php://input');
$data = json_decode($json, true);
fwrite($fs, 'Data: '.print_r($data, true).PHP_EOL);

fwrite($fs, '======================================================================='.PHP_EOL);
$fs and fclose($fs);

pcntl_wait($status); 

} else if ($pid == 0){

exec('sudo sh /git_update.sh &');
}

执行git_update.sh更新git仓库。

为何要这样作呢。由于coding的webhook的等待时间是写死的，要5秒内有反应，这就会致使包含一些须要时间的命令会让webhook的地址验证不成功，从而在push后不回调到地址上。

因此咱们用了多进程来让其中一个执行日志的记录，另外一个负责执行sh文件。

填入回调地址

紧接着咱们在coding中打开部署用的代码库，左侧点击设置-WebHook。好比咱们刚刚的是 http://111.111.111.111:8080/githook.php。

（ps：直接填写IP能够减小域名解析所耗费的时间）

给apache权限

聪明的朋友们测试的时候确定发现了问题，exec里面的代码并不执行怎么办？其实很简单是由于apache的权限不够，只要给予权限就行。

咱们能够先经过lsof -i:80看看apache的执行用户是谁。

好比我这里是www-data用户，而后执行visudo。

而后找到图片上的位置修改为图片上那样，后面那行www-data是要本身添加的。接着保存。保存的话就是ctrl+x而后回车。

这样就可让apache不须要密码就能够用管理员权限执行了。

赶忙测试下看看是否是成功了！

如何部署代码以及结论

如今只要你一更新仓库的代码，就会自动回调到githook.php从而让服务器自动更新代码。即便多几台服务器也是同样的，最简单的方法就是利用公有云服务的镜像功能作成镜像装在集群中的其它机器，而后在coding的WebHook那里加上这些服务器的IP就行。

这应该是全网最完善的相关教程了吧。本身靠着百度到不少不完整的资料琢磨了一自然后写下此教程。找教程。。。最后别太相信百度到的，血的教训~。