Cover
前言
我的博客之前一直是手动更新的，需要自己打包，然后上传到网站。但是项目已经托管在github了，所以何不搞个自动部署呢？
想象一下，网站有修改之后，git push之后等几分钟，网站就自动完成了拉取、打包这些工作，自己更新了，多爽！
其实很久之前就有想做自动部署的想法了，一直在拖，最近最近两天效率比较高(不怎么懒)，于是花了两天时间搞好了自动部署。
A: 什么! 弄个自动部署花了两天？ 太菜了吧！
嗯。是的，其实一小时左右就可以搞完，但是由于刚开始没看到shell报错信息，没定位到问题，后来又因为权限问题，所以这么久。
Webhook
GitHub的webhook可以提供一个push动作的钩子，每当你push成功的时候，会请求一个你指定的URL。
所以自动部署主要实现方式就是：
- 修改代码 push
- github发送请求给你的网站服务器
- 网站服务器收到更新请求，执行自动部署脚本
- 自动部署脚本执行代码拉取，打包，移动文件等动作完成网站的更新部署
大概就是下图这个流程：
拆分步骤
分析实现方式，其实就需要做下面几步：
- 在服务器中安装git并配置密钥，github中添加密钥
- 在服务器中克隆仓库
- 添加项目钩子 (我这里是.php)
- 编辑Shell脚本
- 设置仓库的webhook
1. 安装github
在CentOS中，安装git
yum –y install git
之后配置密钥，并在github中绑定密钥，具体操作可以看我的Github基础使用教程：从今天开始使用git 系列一
2. 克隆仓库
我决定将仓库放在/home/www/中
git clone T-Blog.git
这样我的仓库就在/home/www/T-blog/中了。
这里插一句，有的程序是不需要打包这个环节的，所以一般将本地仓库放在网站目录，而我需要打包，所以我决定将仓库和网站目录分开使用。
3. 添加项目钩子
这里的钩子就是被请求的URL，我这里是PHP的，其他语言也可以参考这个。
我将钩子部署在/CI.go这个地址上，在go方法中，设置最大过期时间为3分钟，然后执行：
- 转到仓库目录
- 拉取最新版本
- 执行Shell脚本CI.sh
在本文最开始我说过我浪费时间其一就是在用php执行shell命令的时候使用了shell_exec()函数，但是该函数在出错的时候得不到友好的返回(其实经过实测exec/system/passthru均得不到友好的错误返回)，所以没有定位好错误。之后找到了一个方法，也就是下面代码中的doShell方法，建议使用该方法执行shell命令。
PS: 我这里设置最大过期时间是为了友好返回，其实也可以更短，网页先结束也行，shell会继续执行的
public function go() {
set_time_limit(3 * 60); //最大过期时间3分钟
$shellPath = "/home/www/T-Blog";
$cmd = "cd $shellPath && sudo git pull && sudo /bin/bash CI.sh";
$res = $this -> doShell($cmd);
print_r($res); // 主要打印结果给github记录查看，自己测试时查看
}
/*
* 执行shell命令
*/
protected function doShell ($cmd, $cwd = null) {
$descriptorspec = array(
0 => array("pipe", "r"), // stdin
1 => array("pipe", "w"), // stdout
2 => array("pipe", "w"), // stderr
);
$proc = proc_open($cmd, $descriptorspec, $pipes, $cwd, null);
// $proc为false，表明命令执行失败
if ($proc == false) {
return false;
// do sth with HTTP response
print_r("命令执行出错！");
} else {
$stdout = stream_get_contents($pipes[1]);
fclose($pipes[1]);
$stderr = stream_get_contents($pipes[2]);
fclose($pipes[2]);
$status = proc_close($proc); // 释放proc
}
$data = array(
'stdout' => $stdout, // 标准输出
'stderr' => $stderr, // 错误输出
'retval' => $status, // 返回值
);
return $data;
}
但是这样不够安全，为了能够只在有效github的请求进来时运行脚本，需要对githb传过来的东西签名认证一下，所以重新写一下go函数。
public function go() {
// webhook上设置的secret
$secret = "iimT";
// 校验发送位置，正确的情况下自动拉取代码，实现自动部署
$signature = $_SERVER['HTTP_X_HUB_SIGNATURE'];
if ($signature) {
$hash = "sha1=".hash_hmac('sha1', file_get_contents("php://input"), $secret);
if (strcmp($signature, $hash) == 0) {
// sign sucess
set_time_limit(3 * 60); //最大过期时间3分钟
$shellPath = "/home/www/T-Blog";
$cmd = "cd $shellPath && sudo git pull && sudo /bin/bash CI.sh";
$res = $this -> doShell($cmd);
print_r($res); // 主要打印结果给github记录查看，自己测试时查看
}
}
}
这里的$secret变量是用来签名的，后面在GitHub上设置webhook的时候需要需要填写这个值。
其实php中执行的git pull命令可以写在CI.sh中，但是我的CI.sh是在仓库中的，为了让我更新CI之后，服务器能够先拉取最新的代码，然后在执行CI，所以我先拉取再执行了脚本。
4. 编辑Shell脚本
之前说过我的仓库与博客根目录不是同一个目录，所以我的脚本需要完成以下事情：
- 安装依赖 `nmp i`
- 打包 `npm run build`
- 移动dist文件夹中的文件到网站根目录
但是由于我是在root用户下操作，但是web下请求执行脚本是www用户，所以还需要对用户权限做一点处理。我也在这一点浪费了挺多时间。所以添加一点：
- 权限处理
最后脚本需求清单就是:
- 权限处理
- 安装依赖 `nmp i`
- 打包 `npm run build`
- 移动dist文件夹中的文件到网站根目录
开始编写脚本
我的仓库目录在：/home/www/T-Blog
网站根目录在/home/wwwroot/iimt_blog/domain/wwwiimt.me/web
最后脚本如下:
# 安装依赖
install_dependices () {
echo "cnpm i" # >> $FILE
output=`cnpm i`
echo "${output}" # >> $FILE
}
# 打包
build () {
echo "cnpm run build" # >> $FILE
output=`cnpm run build`
echo "${output}" # >> $FILE
}
# 更新博客程序
update_src () {
# 删除
echo "rm -rf ${deployPath}/index.html" # >> $FILE
output=`rm -rf ${deployPath}/index.html`
echo "${output}" # >> $FILE
# 删除
echo "rm -rf ${deployPath}/static" # >> $FILE
output=`rm -rf ${deployPath}/static`
echo "${output}" # >> $FILE
# 更新
echo "cp -r ./dist/* ${deployPath}/" # >> $FILE
output=`cp -r ./dist/* ${deployPath}/`
echo "${output}" # >> $FILE
}
echo_start () {
echo "--------------- DEPLOY START @$datetime --------------------------------------" # >> $FILE
export PATH=$PATH:/opt/nodejs/bin/
echo $PATH
echo "Deploying..."
}
echo_end () {
echo "Deploy Done, everythings is OK!"
datetime=$(date '+%Y-%m-%d %H:%M:%S')
echo "--------------- DEPLOY DONE @${datetime} ----------------------------------------" # >> $FILE
}
# 提升权限
update_authorization () {
echo "chown -R www:www ./ && chmod -R 777 ./" # >> $FILE
chown -R www:www ./ && chmod -R 777 ./
}
echo_start && update_authorization && install_dependices && build && update_src
我将上面需求清单的每一项都写成了函数，最后使用&&配合执行，防止前面没有执行成功触发后面动作。
保存，执行测试一下
./CI.sh
成功完成上面动作，博客根目录文件也更新了。可以去设置github的webhook了。
5. 设置webhook
已经准备好了仓库，并且写好了钩子和脚本。
然后在GitHub上打开我的仓库T-Blog，在settings中找到webhook，添加webhook，填写好信息就OK了。
添加之后你还可以在这个webhook的页面中查看之前github的请求，与返回情况，便于调试。
然后在自己电脑上随便做点更改，然后推送到github中，等待3分钟左右，网站就已经自动更新了~
我是谁？
我是iimT，大学生，技术宅，计算机科技爱好者，电音小王子。
我的博客：www.iimt.me
我在Weibo：@_iimT
我在B站：https://space.bilibili.com/69824765/#/
想看到我的更多更新的话，很乐意你关注我！
你是谁？
欢迎在文后留下评论，一起讨论，欢迎认识新朋友。
如果你也有博客，在分享你的东西，欢迎交流、友链(本人博客底部可申请)。
下一篇见~
