当进行开发的环境在本地,而运行的环境要在服务端时,每一次提交代码都需要在服务端pull一次。而利用git的hooks功能,能够让我们省去这一步,下面我就以码云的webhooks为例,实现服务端的代码自动同步部署。
更新历史
- 2017.12.29:完成初稿
了解 git 的 hooks
关于 git 钩子
Git 能在特定的重要动作发生时触发自定义脚本。 有两组这样的钩子:客户端的和服务器端的。 客户端钩子由诸如提交和合并这样的操作所调用,而服务器端钩子作用于诸如接收被推送的提交这样的联网操作。 你可以随心所欲地运用这些钩子。
如何使用钩子
钩子都被存储在 Git 目录下的 ==hooks== 子目录中。 也即绝大部分项目中的 ==.git/hooks== 。 当你用 ==git init== 初始化一个新版本库时,Git 默认会在这个目录中放置一些示例脚本。这些脚本除了本身可以被调用外,它们还透露了被触发时所传入的参数。 所有的示例都是 shell 脚本,其中一些还混杂了 Perl 代码,不过,任何正确命名的可执行脚本都可以正常使用 —— 你可以用 Ruby 或 Python,或其它语言编写它们。 这些示例的名字都是以 ==.sample== 结尾,如果你想启用它们,得先移除这个后缀。
把一个正确命名且可执行的文件放入 Git 目录下的 hooks 子目录中,即可激活该钩子脚本。 这样一来,它就能被 Git 调用。 接下来,我们会讲解常用的钩子脚本类型。
具体使用可以参考官方文档:Git Hookes
了解 webhooks
钩子功能(callback),是帮助用户 push 了代码后,自动回调一个你设定的 http 地址。 这是一个通用的解决方案,用户可以自己根据不同的需求,来编写自己的脚本程序(比如发邮件,自动部署等);目前,webhooks 支持多种触发方式,支持复选。
webhooks 的请求方式为POST请求,有两种数据格式可以选择,JSON 和 web 的 form参数,可以自行选择是否使用密码来确定请求。(注意:该密码是明文)
不同托管平台的POST数据格式都不太一样,不过也不会有太大影响,只是解析数据的时候注意就行了,下面是码云的 Push 操作回调的 json 数据:
{
"before": "fb32ef5812dc132ece716a05c50c7531c6dc1b4d",
"after": "ac63b9ba95191a1bf79d60bc262851a66c12cda1",
"ref": "refs/heads/master",
"user_id": 13,
"user_name": "123",
"user": {
"name": "123",
"username": "test123",
"url": "https://gitee.com/oschina"
},
"repository": {
"name": "webhook",
"url": "http://git.oschina.net/oschina/webhook",
"description": "",
"homepage": "https://gitee.com/oschina/webhook"
},
"commits": [
{
"id": "ac63b9ba95191a1bf79d60bc262851a66c12cda1",
"message": "1234 bug fix",
"timestamp": "2016-12-09T17:28:02 08:00",
"url": "https://gitee.com/oschina/webhook/commit/ac63b9ba95191a1bf79d60bc262851a66c12cda1",
"author": {
"name": "123",
"email": "123@123.com",
"time": "2016-12-09T17:28:02 08:00"
}
}
],
"total_commits_count": 1,
"commits_more_than_ten": false,
"project": {
"name": "webhook",
"path": "webhook",
"url": "https://gitee.com/oschina/webhook",
"git_ssh_url": "git@gitee.com:oschina/webhook.git",
"git_http_url": "https://gitee.com/oschina/webhook.git",
"git_svn_url": "svn://gitee.com/oschina/webhook",
"namespace": "oschina",
"name_with_namespace": "oschina/webhook",
"path_with_namespace": "oschina/webhook",
"default_branch": "master"
},
"hook_name": "push_hooks",
"password": "pwd"
}
其他的具体数据可以到各个官网查看:码云、Coding、GitHub
在 Ubuntu + Apache + 码云的尝试
准备工作
1、首先你要搭建好LAMP的的开发环境 可以看腾讯开发者实验室的课程
2、当然要有git的环境了
3、要将代码方在一个提供webhooks支持的代码托管平台上,如果自己搭建 git 服务器则要自己实现 webhooks 回调
开始干活
- 创建web服务器用户目录,这里以apache用户为例,不同的环境请根据自己环境自行修改:
sudo mkdir /var/www/.ssh
sudo chown -R apacheuser /var/www/.ssh/ // 这里的用户要是 Apache 的运行用户,下同
- 生成公钥
公钥有两个:1. git用户公钥,2. 部署公钥:
- 用户公钥(用于git clone时认证权限)
ssh-keygen -t rsa -C "sample@gmail.com" # 填自己的邮箱
# 然后一直回车就行
# 生成的文件通常是 /root/.ssh/id_rsa,如果非root用户请查看提示上的路径
- 部署公钥
sudo -Hu apacheuser ssh-keygen -t rsa # 请选择 "no passphrase",一直回车下去
- 配置公钥
- 用户公钥
sudo cat /root/.ssh/id_rsa.pub # 查看生成的密钥内容,复制全部
将公钥的内容粘贴到用户->设置 中的SSH公钥中
- 部署公钥
sudo cat /var/www/.ssh/id_rsa.pub # 查看生成的密钥内容,复制全部
将公钥内容添加到具体项目 -> 管理 中的部署公钥
- git 的全局配置
sudo -Hu apacheuser git config --global credential.helper store # 永久保存
sudo -Hu apacheuser git config --global user.name "name"
sudo -Hu apacheuser git config --global user.email "shample@gmail.com" # 邮箱请与码云上一致
配置完成之后可以 clone 或 pull 项目来验证是否配置成功(注意:要切换成Apache运行用户来进行操作),若多次操作只需输入一次用户名、密码,即配置成功,若每一次操作都有输入用户名密码,则配置不成功,需要重新检查配置。
- 准备钩子文件
在你的www目录建立一个目录hook, 里面放上一个php文件index.php,内容如下:
<?php
// 这里只是最简单的拉取代码,如果要做更加多的操作,如验证、日志,请自己解析push内容并操作
// 获取push数据内容的方法
$requestBody = file_get_contents("php://input");
// 只需这一行代码便可拉取
shell_exec("cd /var/www/Project && git pull"); // 目录换成项目的目录
?>
修改目录权限:
chown -R apacheuser /var/www/hook # 这里请改成你创建的hook目录
chown -R apacheuser /var/www/Project # 这里请改成你的项目目录
确保你的hook文件可以访问:http://example.com/hook/index... ,钩子准备完成。
- 配置webhooks
如果链接可用,则大功告成,只需把仓库 clone 之后,再向码云提交,变回自动被 服务器 pull
注意事项
如果配置都没有问题,但是就是不会自动拉取,那应该是用户的权限配置问题,可以先查看运行php代码的具体用户是什么,然后为该用户开启权限。
system("whoami"); // 查看是哪个用户执行该命令