阅读 122

GitHub和WebHooks自动部署PHP项目

前言

在项目开发中,都会遇到两个过程,一个是版本控制,另一个是代码发布

版本控制目前有两种途径,一个是git,另一个是svn。我用的是git,在这里就不介绍git和svn的差异了。

而代码发布,在最初的时候,用的都是ftp直接将代码拉倒服务器上(因为这是我自己的项目),这样子不仅费事,还容易出事。

下面就引入GitHub和WebHooks达到自动部署。

使用

在我们完成开发并测试通过之后,将代码提交到git上,git就自动调用hook将代码pull到服务器上。

原理

步骤

创建项目的用户

在当git访问服务器上的webhook脚本时,主要任务就是执行git pull将代码更新到服务器上,这时是以nginx的运行用户(ps -ef | grep nginx 可查看)去执行这个命令的,所以运行nginx的用户要拥有对项目读写的权限。

创建ssh-key并配置到github

上面提到的用户,需要给它配置ssh-key,配置ssh-key是为了能够方便在拉取代码pull的时候,可以不用输入帐号密码,在当webHooks脚本执行的时候,用的是nginx的用户,所以应该要以nginx的运行用户去创建一个ssh-key。 可以自己创建一个新的用户,用这个用户去运行nginx(下面介绍),然后将项目的分给这个用户(下面介绍)。

创建webHooks并部署项目

这一步是为了在项目push到master版本的时候,由webHooks完成自动部署。

  1. 在gitHub上为需要自动部署的项目新建一个WebHools

    Setting -> WehHooks -> Add web

    在创建的时候需要输入密码。

  2. 填写webhook基本信息

    • webhook请求的接口

      前面有说过了,这个接口实际上是执行git pull将代码更新到服务器项目中,下面是php版本代码。

      <?php
      // 本地仓库路径 既项目路径
      $local = '/data/web/testWebHooks';
      
      // 如果仓库目录不存在,返回错误
      if (!is_dir($local)) {
          header('HTTP/1.1 500 Internal Server Error');
          die('Local directory is missing');
      }
      
      //如果请求体内容为空,返回错误
      if (!isset($_POST['payload'])) {
          header('HTTP/1.1 400 Bad Request');
          die('HTTP HEADER or POST is missing.');
      }
      
      //  上图中第2步的Content Type是application/x-www-form-urlencoded,所应用post接受
      $payload = json_decode($_POST['payload'], true);
      
      // 签名
      if (!isset($_SERVER['HTTP_X_HUB_SIGNATURE']) || !$_SERVER['HTTP_X_HUB_SIGNATURE']) {
      	header('HTTP/1.1 403 Bad Request');
          die('Permission denied.' . json_encode($_SERVER));
      }
      $signature = $_SERVER['X-Hub-Signature'];
      
      list($algo, $hash) = explode('=', $signature, 2);
      //计算签名
      $secret = '******';	// 上图中第三部填写的密码
      $payloadHash = hash_hmac($algo, $payload, $secret);
      if ($hash !== $payloadHash){
          header('HTTP/1.1 403 Bad Request');
          die($signature . '  ' . $_SERVER['X-Hub-Signature']);
      }
      复制代码

      这是一个php脚本,主要有两个功能,一个是校验,另一个是更新代码。校验是为了防止你的脚本被别人一直请求,第二个就是从git上拉取代码并更新。

      如果你的项目是vue或者是其他需要编译的项目,可以在更新代码之后执行编译过程。

      在git上填写信息之后,会自动去请求这个接口进行测试,http返回200表示成功。具体的请求记录在提交信息下方的Recent Deliveries

      注意

      1.确保PHP正常执行系统命令。写一个PHP文件,内容:

      <?php shell_exec('ls -la')
      复制代码

      在通过浏览器访问这个文件,能够输出目录结构说明PHP可以运行系统命令。

测试提交代码到git并完成自动部署

当我们通过git push提交代码之后,可以在github的webhook页面最下面看到webhook的执行记录。如果提示成功了,可以去刷新页面查看是否有更新成功。

关注下面的标签,发现更多相似文章
评论