Gitee码云通过WebHooks实现自动同步代码部署

码云(Gitee)的WebHooks功能,可以在我们每次提交代码后,向我们设定的地址post一个更新的json信息,这样我们就可以根据该信息,来自动拉去我们的代码,实现自动同步功能.

第一步 配置WebHooks

在[码云](https://gitee.com/)上,自己的项目中,选择"管理" --> "WebHooks",这个时候你能看到下图界面.
注:1 URL填写为自己接收端的地址,配置后,每次代码更新后会通过该地址发送更新的消息.
   2 密码:可以不填写.

第二步 服务器脚本配置

在保存好脚本文件后,注意一下事项:
1 该脚本必须在PHP环境中运行,其他环境根据情况修改.
2 需要将该文件访问地址,替换到第一步的URL中.
3 根据实际情况,修改脚本中的参数:savePath,gitPath,email ,name.
4 isClone 变量,第一次clone的时候,需要设置成false,已经clone过后,需要设置成true.

//git webhook 自动部署脚本
//项目存放物理路径,第一次clone时,必须保证该目录为空
$savePath = "/www/wwwroot/eia/server/";
$gitPath  = "https://gitee.com/jerry_hui/tools.git";//代码仓库
$email = "your email";//用户仓库邮箱
$name  = "your name";//仓库用户名,一般和邮箱一致即可

$isClone = false;//设置是否已经Clone到本地,true:已经clone,直接pull,false:先clone.

//如果已经clone过,则直接拉去代码
if ($isClone) {
    $requestBody = file_get_contents("php://input");
    if (empty($requestBody)) {
        die('send fail');
    }

    //解析Git服务器通知过来的JSON信息
    $content = json_decode($requestBody, true);
    //若是主分支且提交数大于0
    if ($content['ref']=='refs/heads/master' && $content['total_commits_count']>0) {

        $res = PHP_EOL."pull start --------".PHP_EOL;
        $res .= shell_exec("cd {$savePath} && git pull {$gitPath}");//拉去代码
        $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：';
        $res_log .= $res.PHP_EOL;
        $res_log .= "pull end --------".PHP_EOL;
        file_put_contents("git-webhook_log.txt", $res_log, FILE_APPEND);//写入日志到log文件中
    }
}else {
    $res = "clone start --------".PHP_EOL;
    //注:在这里需要设置用户邮箱和用户名,不然后面无法拉去代码
    $res .= shell_exec("git config --global user.email {$email}}").PHP_EOL;
    $res .= shell_exec("git config --global user.name {$name}}").PHP_EOL;
    $res .= shell_exec("git clone {$gitPath} {$savePath}").PHP_EOL;
    $res .= "clone end --------".PHP_EOL;
    file_put_contents("git-webhook_log.txt", $res, FILE_APPEND);//写入日志到log文件中
}

注意事项

1. 如果仓库是公开的,那么上述配置则不需要修改,因为公开的仓库,在pull的时候,不需要账户和密码.

2. 如果仓库是私有的,那么还需要做一下配置:
   Windows配置:
   1 进入 C:\Documents and Settings\xxx.,找到.git-credentials文件,
   touch .git-credentials

   2 用记事本修改.git-credentials.格式如下:
   https://{ username }:{ password }@ xxx .com
   eg:https://zhangsan:[email protected]

   3 在任意目录 打开git-bash，输入:
   git config –global credential.helper store

   4 执行完后去查看 C:\Documents and Settings\Administrator.gitconfig 这个文件，发现多了一项：
   [credential] helper = store

   5 重新使用git pull.此时便不再需要输入密码.

   Linux配置:
   1 进入 /home/chinaestone(有些在root下面),找到.git-credentials文件,

   2 输入内容如下:
   https://{username}:{password}@github.com
   eg:https://zhangsan:[email protected]

   3 保存文件退出后,输入以下指令:
   git config –global credential.helper store

   4 此时在/home/chinaestone/.gitconfig 会新增一项
   helper = store

   5 重新使用git pull.此时便不再需要输入密码.