Webhooks 实现项目自动部署

假设,我们有三个环境:

  1. 远程仓库:如Github、GitLab
  2. 本地仓库:日常开发用的。
  3. 服务器仓库:一般是自动在测试服务器,或者生产服务器。

Webhooks 实现项目自动部署目的就是:
当有新的本地 git push 到远程仓库时,服务器仓库自动 git pull 新的代码。

一、工作原理

Webhooks工作原理很简单,如下图。

image

当我们 push 代码到线上仓库,线上仓库必然知道这个 push 操作,远程仓库就会webhooks(回调)我们预留的URL。

而这个URL对应一段后台代码,这段代码执行了git pull,这样就实现下拉代码操作。

上图是以PHP为例,实际上用Java、Javascrtip等都可以,理论上一行代码就可以搞定。

不过实际稍微复杂一点,需要进行一些安全验证。

二、准备工作

  • 这里以 PHP 脚本实现,所以服务器需要 lnmp 环境
  • 需要 Git,并配置好 SSH KEY 给远程仓库,请参考这里

三、预测试

写一个 PHP 脚本,并在浏览器下访问代码如下:

<?php
$local = '/home/wwwroot/default/project'; //项目路径
$result = shell_exec("cd {$local} && git pull 2>&1");
echo '<pre>';
var_dump($result);

若浏览器输出 Already up-to-date.,说明我们脚本能够正确的进行git pull操作。接下来就与远仓库的 webhooks 对接。

若没有按照以下提示进行处理:

/*
 * 这里有几点需要注意:
 *
 * 1.确保PHP正常执行系统命令。写一个PHP文件,内容:
 * <?php var_dump(shell_exec('ls -la'));
 * 在通过浏览器访问这个文件,能够输出目录结构说明PHP可以运行系统命令。
 *
 *
 * 2、PHP一般使用www-data或者nginx用户运行,PHP通过脚本执行系统命令也是用这个用户,
 * 所以必须确保在该用户家目录(一般是/home/www-data或/home/nginx)下有.ssh目录和
 * 一些授权文件,以及git配置文件,如下:
 * ```
 * + .ssh
 *   - authorized_keys
 *   - config
 *   - id_rsa
 *   - id_rsa.pub
 *   - known_hosts
 * - .gitconfig
 * ```
 * 若没有复制一份 cp ~/.ssh/* /home/www/
 *
 *
 * 3.在执行的命令后面加上2>&1可以输出详细信息,确定错误位置
 *
 *
 * 4.git目录权限问题。比如:
 * fatal: Unable to create '/data/www/html/awaimai/.git/index.lock': Permission denied
 * 那就是PHP用户没有写权限,需要给目录授予权限:
 * sudo chown -R www:www /home/wwwroot/default/project
 * sudo chmod -R g+s /home/wwwroot/default/project
 * sudo chmod -R 775 /home/wwwroot/default/project
 *
 *
 * 5.SSH认证问题。如果是通过SSH认证,有可能提示错误:
 * `Could not create directory '/.ssh'.`
 * 或者
 * `Host key verification failed.`
 */

四、PHP代码

这里我从 Github 上找了一个脚本

按照说明进行部署即可。

五、测试

以上我们都订阅了push事件。

这样只要我们本地仓库有push命令,都会执行一遍服务器仓库的git pull操作。

相关连接

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 来新单位两周了,渐入状态。以后不再说是新单位。 本周感受: 1自身英语水平方面真的该好好补一补。肚子里...
    赵妖镜Karen阅读 213评论 0 0
  • 一直嫌弃自己脸蛋平平,没有朝气的凌凌。 填充脂肪后 五官精致,娇俏脸蛋,惊艳到她自己都不可思议。 今天,就带大家了...
    神刀任叔任学会阅读 231评论 0 0
  • @author ASCE1885的 Github 简书 微博 CSDN 知乎由于微信公众号屏蔽外部链接,详情请点...
    asce1885阅读 869评论 0 3
  • 电子笔记的好处就是随时随地的记录,包括我们在浏览网页的时候,看到喜欢的图片,有趣的文章,都希望永久保存,不过。目前...
    andyhacker阅读 3,437评论 0 0