github hooks钩子的搭建(代码同步功能,webhooks)

钩子是什么,就是将本地代码推送至github后自动将代码同步至服务器。

搭建步骤

  • 在服务器查找运行php的用户,为他生成deploy-key,保存在github上
  • 在服务器拉取项目仓库
  • 在服务器项目根目录下建立代码同步的deploy.php
  • github上设置仓库的webhooks
  • 本地拉取仓库提交代码测试

1.设置deploy-key

查找php是什么用户运行的

ps aux | grep php

我的显示是www用户 但是查看所有用户

cat  /etc/passwd | grep www

查找出来是www-data
查找用户组

cat /etc/group | grep www

查找出来也是www-data
所以我判定我的php执行用户是www-data 属于www-data用户组

配置服务器git:

git config --global user.name "name"
git config --global user.email "email" 

执行命令

sudo -Hu www-data ssh-keygen -t rsa

生成www-data用户的deploy-key(为什么要给www-data用户生成key,因为在本地提交代码时,github会请求服务器的php文件从而同步服务器代码)

这时候报错

报错.png

报错原因是无法在目录下创建目录以及找不到目录
原来www目录属于root用户组 权限是rwxr-xr-x


image.png

我们需要进入www目录创建.ssh目录后更改目录用户权限

chown -R  www-data:www-data ./.ssh/

这时候再次执行命令 sudo -Hu www-data ssh-keygen -t rsa ,生成deploy-key。将生成的id_rsa.pub文件内容,添加到项目中的 deploy keys中。

打开github上的项目仓库,给项目添加deploy-key

image.png

2. 在服务器上拉取自己的仓库(使用ssh方式)

3.建立代码同步的deploy.php

在仓库根目录下建立deploy.php文件

<?php

@file_put_contents('./req.log',json_encode($_POST).PHP_EOL, FILE_APPEND|LOCK_EX);

class Deployment {
 
    public $serect = 'zjh19971010.'; //自定义的webhooks中配置的密钥
 
    public function deploy()
    {
        $requestBody = file_get_contents('php://input'); //每次推送的时候,会接收到post过来的数据。
        $payload = json_decode($requestBody, true);    //将数据转成数组,方便取值。
        if(empty($payload)){
            //写日志
            $this->write_log('send fail from github is empty');exit;
        }else{
            //获取github推送代码时经过哈希加密密钥的值
            $signature = $_SERVER['HTTP_X_HUB_SIGNATURE'];
        }
        
        if (strlen($signature) > 8 && $this->isFromGithub($requestBody,$signature)) {
            //验证密钥是否正确,如果正确执行命令。
            $res = shell_exec("cd /var/www/html/ball_mation/ball_mation/ &&                         
git pull 2>&1"); // 项目目录
            $res_log = "\n -------------------------".PHP_EOL;
            $res_log .= '['.$payload['commits'][0]['author']['name'] . ']' . '向[' . $payload['repository']['name'] . ']项目的' . $payload['ref'] . '分支'.$_SERVER['X-GitHub-Event'].'了代码。commit信息是:'.$payload['commits']['message'].'。详细信息如下:' . PHP_EOL;
            $res_log .= $res.PHP_EOL;
            http_response_code(200);
            $this->write_log($res_log);
        }else{
            $this->write_log('git 提交失败!');
            abort(403);
        }
    }
    
    public function isFromGithub($payload,$signature)
    {
        //$hash是github的密钥。然后与本地的密钥做对比。
        list($algo, $hash) = explode("=", $signature, 2); 
        return $hash === hash_hmac($algo, $payload, $this->serect);
    }
 
    public function write_log($data)
    {
        // 此处加载日志类,用来记录git push信息,可以自行写。    
        file_put_contents('./push_push.log', $data.PHP_EOL, FILE_APPEND|LOCK_EX);
    }
}
 
$deploy = new Deployment();
 
if($_SERVER['REQUEST_METHOD'] == 'POST'){
    //触发此代码的时候,git是以post方式触发
    $signature = $deploy->deploy();
}

代码中的$serectshell_exec()函数中的项目路径需要更改为自己的

4.设置仓库的webhooks

image.png

填写自己的serect跟deploy.php访问url即可,传输方式选择json
image.png

5.本地测试
拉取仓库代码在本地修改提交后,检查服务器代码是否同步,若同步即为成功

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