🎈 同步原理
- 随着企业的发展，越来越多的公司会用上代码自动化部署
- 这里详细介绍利用
Gitee 的 WebHooks 实现代码自动化部署 - 其实在使用
git push 推送代码时，都会触发 Gitee 的 WebHooks 的回调配置 - 而
Gitee 的 WebHooks 推送不止支持代码自动化同步，而且支持钉钉、企业微信和飞书的实时推送 - 具体配置可进入
WebHooks 中查看各板块的 更多说明
🎈 发送数据
- 由帮助文档中可知，
Gitee 每次触发 WebHooks 后，都会向我们配置的 WebHooks 链接中发送如下数据示例 - 如果你
WebHooks 配置了密码，其实就会被携带在 password 字段中
{
"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"
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
🎈 简单同步
- 由上面原理可以知道，你只要在
WebHooks 中配置你的回调地址 - 每次执行
git push 的时候，都会调用该回调地址，由此，你可以在回调地址中自己写同步代码的逻辑即可实现同步 - 下面脚本即可实现简单同步，其实就是通过
shell_exec 函数执行 shell 脚本，先切换到项目目录，然后执行 git pull 拉取代码，即可实现代码与仓库同步 - 要使用该方法，必须要取消禁用
shell_exec 函数
<?php
$path = "你的项目部署路径";
$requestBody = file_get_contents("php://input");
if (empty($requestBody)) {
die('send fail');
}
$content = json_decode($requestBody, true);
if ($content['ref']=='refs/heads/master' && $content['total_commits_count']>0) {
$res = shell_exec("cd {$path} && git pull 2>&1");
$res_log = '-------------------------'.PHP_EOL;
$res_log .= $content['user_name'] . ' 在' . date('Y-m-d H:i:s') . '向' . $content['repository']['name'] . '项目的' . $content['ref'] . '分支push了' . $content['total_commits_count'] . '个commit：' . PHP_EOL;
$res_log .= $res.PHP_EOL;
file_put_contents("git-webhook.txt", $res_log, FILE_APPEND);
}
echo '很棒:'.date('y-m-d H:i:s');
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
🎈 验证密码
- 上面代码并没有验证密码和签名密钥，需要是你的代码库是公开
public 类型的，在设置 WebHooks 时，不设置密码，才可以使用 - 如果你设置了密码，如何去验证呢
<?php
$password = '你设置的webhoos密码';
$body = json_decode(file_get_contents("php://input"), true);
if (!isset($body['password']) || $body['password'] !== $password) {
echo '密码错误';
exit(0);
}
🎈 验证签名密钥
<?php
$headers = getallheaders();
$gitee_token = $headers["X-Gitee-Token"];
$gitee_timestamp =$headers["X-Gitee-Timestamp"];
echo "gitee_token: $gitee_token <br />\n";
echo "gitee_timestamp: $gitee_timestamp <br />\n";
$sign_key = "LEreKhDjwoN8aZ8L";
$sec_str = "$gitee_timestamp\n$sign_key";
$compute_token = base64_encode(hash_hmac('sha256', $sec_str,$sign_key,true));
echo "computetoken: $compute_token <br />\n";
if($compute_token!=$gitee_token){
die('sign is not right');
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
🎈 私有仓库配置
- 如果你的仓库并不是公开
public 的，而是私有 private 的 - 你需要设置
git 的基本配置，设置账号和邮箱 - 这样你在使用命令的时候，系统就会知道是谁，这个用户有没有操作权限了
git config --global user.name "用户名"
git config --global user.email "邮箱"
git config --global credential.helper store //会生成.gitconfig 的文件，就不用每次都设置账号和邮箱
🎈 宝塔 webhook 实现同步
- 🎨 安装 git 服务
- 如果你服务器上安装了宝塔，那么可以通过宝塔
webhook 服务实现同步功能 - 首先需要安装
git 服务，可以在宝塔的终端，运行以下命令
// 查看是否安装了git
git --version
// 如果未安装，执行安装命令
yum install git
- 🎨 配置公钥
- 首先查看服务器上是否已经存在公钥
id_rsa.pub 文件 - 如果存在，直接复制里面的内容，如果不存在，先生成
// 查看是否由公钥文件
ll ~/.ssh/
// 如果存在公钥，则执行
cat ~/.ssh/id_rsa.pub
// 如果不存在，则重新生成
ssh-keygen -t rsa
- 🎨 安装宝塔 webhook 服务
- 在宝塔商城中，搜索
webhook ，点击安装即可
- 🎨 设置同步脚本
- 安装完成后，点击编辑，即可设置同步脚本
- 同步脚本其实也就是判断了服务器是否存在仓库，存在则执行
git pull 命令，不存在，则执行 git clone 命令 - 脚本代码如下：
#!/bin/bash
echo ""
date --date='0 days ago' "+%Y-%m-%d %H:%M:%S"
echo "Start"
if [ ! -n "$1" ];
then
echo "param参数错误"
echo "End"
exit
fi
gitPath="/www/wwwroot/$1"
gitHttp="git@gitee.com:autofelix/webhook.git"
echo "Web站点路径：$gitPath"
if [ -d "$gitPath" ]; then
cd $gitPath
if [ ! -d ".git" ]; then
echo "在该目录下克隆 git"
git clone $gitHttp gittemp
mv gittemp/.git .
rm -rf gittemp
fi
git pull
echo "End"
exit
else
echo "该项目路径不存在"
echo "End"
exit
fi
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 🎨 设置宝塔 hook 地址
- 设置完脚本之后，我们需要拿到这个脚本的地址，然后配置到
gitee 中 webhooks 中即可 - 点击刚刚设置的脚本，点击
查看密钥 即可查看 hook 地址 - 你的服务器一定要对外开放，也就是
hook 的地址要是外网 ip，不然 gitee 是找不到你这台服务器的，如果是内网地址，也是配置不了的哈 - 你会发现
hook 地址中带了个参数 param，这个参数其实就是上面脚本中的 $1，所以这里要改成你自己的仓库名称 - 配置
gitee 的 webhooks 时候，除了修改这个参数和密码外，其他配置默认即可
- 🎨 设置 git 配置
- 在宝塔终端中配置基本的
git 配置即可
git config --global user.name "用户名"
git config --global user.email "邮箱"
git config --global credential.helper store //会生成.gitconfig 的文件，就不用每次都设置账号和邮箱
- 🎨 同步测试
- 修改代码后，执行
git push 命令推送到 gitee，看是否同步成功 - 可以在
gitee 中 webhooks 查看状态，也可以在宝塔中查看同步日志
