GitLab 实现代码自动部署

在当下使用 GIT 来管理代码已是一种很是流行的方式了。使用 GIT 能够很方便的给代码建立分支，撤销不须要的提交，与他人合做共同编写代码。

GitLab 是基于 GIT 实现的现代化的开发者协做平台，它将 issues, code review, CI 和 CD 整合到独立的网站UI，弥补了 GIT 在可视化操做方面的不足。

本文目的

本文的目的是配置实如今 GitLab 平台上的代码自动部署。想要达到的效果是这样子的，当客户端向 GitLab 服务器的特定分支（如：prod）提交代码时，GitLab 服务器会发送通知给线上代码服务器，代码服务器收到通知以后再拉取 GitLab 服务器上该分支的最新代码。

效果图以下：

有了 GitLab ，只须要三步就能够实现以上描述的效果了。

步骤1、准备两个脚本

在代码服务器端准备好一份处理 GitLab 服务器通知的脚本和一份拉取代码的脚本。

GitLab 服务器所发出来的通知，其实就是向代码服务器发出一个 http 请求，请求中包含了本次提交中的相关信息，如所提交的分支、谁提交的、本次更新的代码等等信息。

因此在代码服务器中添加一个脚本，专门处理该请求便可。

能够参考一下的 PHP 代码：

<?php 
// 处理 GitLab 请求的脚本

$rowData = file_get_contents('php://input', 'r');;
$rowData = json_decode($rowData,true);

$output    = '';
$type = $_GET['type'];

// 只拉取 prod 分支的代码到服务器
if($rowData['ref'] == 'refs/heads/prod'){
    if('ims' == $type){
        // 触发拉取代码的脚本
        exec('./post-ims',$output);
    }
    logg($type." output:".json_encode($output));
}
logg($type.':'.$rowData['user_name']." commit to branch:".$rowData['ref']);

function logg($data){
    $text    = '['.date('Y-m-d H:i:s').'] '.$data."\n";
    file_put_contents('./log/gitlab'.date('ym').'.log',$text,FILE_APPEND);
}

还有一个就是处理拉取 GitLab 服务器更新到代码服务器的脚本。该脚本能够很简单，只须要将当前工做目录切换到项目的工做目录，而后执行拉取代码的命令便可。

参考如下 shell 脚本：

#!/bin/bash
# 拉取代码的脚本

cd /www/ims/
git pull origin prod

步骤2、配置 webhooks

在项目中配置 webhooks（Web 钩子） 其实就是在项目中注册一个触发器，当项目中的某个事件发生时，该触发器就会被触发。在 GitLab 中的触发器就是一个 http 请求，即一个 http 连接。

在 GitLab 中，要达到咱们上面预设的效果，咱们须要设置项目的推送事件的 webhook。一个能访问到咱们步骤一添加的 PHP 脚本的连接。

配置所在的路径是：

项目主页 > setting > webhooks

在该页面添加一个推送事件的触发器便可，相似这样子的 URL：

http://example.com/gitlab.php?type=ims

保存以后，能够测试下该连接是否正确。它会模拟发送一个推送请求的数据，格式和正常的推送的同样。在代码服务器端就能够根据这个来调试了。

步骤3、添加秘钥

既然是代码自动部署，那固然是彻底不须要人为参与的啦，这将包括不须要人为输入密码。

GitLab 提供了让每一个帐号使用秘钥登陆的功能，配置了帐号秘钥以后就能够无密码登陆帐号了。代码自动部署正是须要这样子的功能了。

首先要在代码服务器端生成秘钥：

使用命令 ssh-keygen ，连续按三次回车便可生成一对无密码保护的秘钥，它们的名称分别是 id_rsa 和 id_rsa.pub

而后将 id_rsa.pub 的内容添加到 GitLab 帐号：

在 GitLab 帐号的 profile setting > SSH keys 粘贴并保存便可

须要注意的地方

经过以上三步，如今已经可以实现代码自动部署了。

若是完成了以上步骤以后，还不能实现代码自动部署，最可能出现问题的是帐号的权限问题了。有两个地方可能出现权限的问题。

1. GitLab 帐号的权限

   自动部署所绑定的帐号须要有权限访问该项目。

2. 代码服务器端执行脚本的用户的权限

   首先，该用户须要有权限对项目目录进行读写；  
   而后是，该用户的秘钥信息绑定的是正确的 GitLab 帐号

（完）