给你的项目增加Webhooks，自动进行部署（包含Github/Gitlab）

前言

Github 或者 Gitlab 的 Webhooks，允许用户订阅特定的事件，如 commit, push，两者不尽相同，但本质差不太多。Github 的可以参看github webhooks，Gitlab 可以参看gitlab webhooks。

本文后续都以 Github 为例进行讲解，Gitlab 相关可以参考相关内容。

自动部署脚本

Webhooks 的作用就是在特定的事件执行的时候触发自定义的动作。本质上，Github 的 Webhooks 触发后，会给相应的 URL(自行设置，后面会讲解)发送 POST 请求，请求头中含有 event 等相应的信息。

而正确响应后的事件，比如 push 完之后，触发自动部署脚本，现在我们来写一个简单的脚本。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#!/bin/bash
PROJECT_DIR = 'path-to-your-project'

echo 'start'
cd $PROJECT_DIR

echo 'pull code'
git reset --hard origin/master && git clean -f
git pull && git checkout master

echo 'run npm script'
npm run build

echo 'finished'

脚本大概的作用就是 cd 到项目目录，拉取最新的代码，build 代码(该步骤不一定需要，如果你的代码直接可以上测试/生产环境)。你必须保证，脚本中涉及的环境变量是可用的，比如git，npm等等。

我们把这个脚本命名为deploy.sh，暂时放在一边，等需要的时候再用。

设置 Webhooks

在你的项目中，通过Settings -> Webhooks -> Add webhook进入 webhook 设置页面。我们以下都以 push 事件为例。

alt

Payload URL就是 push 之后，请求的 url，我们这是https://example.com/app。

Content type目前有两种，根据 server 提供的来写，我们选择 json 格式的，因为后面的 server 使用的是 json 的。

Secret就是密码了，后面校验的时候需要用到。

events就是触发的事件列表，我们选 push 就行了，可以选择全部事件(第二个选项)，也可以根据需要选择(第三个选项)。个人建议最好是根据需要去选择，不然会发送很多无谓的请求，加重服务器的压力。

然后就是处理请求的逻辑了，目前 Github 上有很多处理的 handler。对于前端，当然是 node 的最熟悉，可以采用github-webhook-handler，但是这个单个 webhook 处理比较方便，多个会比较麻烦，所以这里采用的就是我自己撸的一个支持多个 webhooks 的node-github-webhook。

安装

1
npm install node-github-webhook --save

入口文件 app.js

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
var http = require('http');
var createHandler = require('node-github-webhook');
var handler = createHandler({ path: '/app', secret: 'appsecret' }); // single handler

function execFunc(content) {
  var exec = require('child_process').exec;
  exec(content, function (error, stdout, stderr) {
    if (error) {
      console.error('exec error:' + error);
      return;
    }
    console.log('stdout:' + stdout);
    console.log('stderr:' + stderr);
  });
}

http
  .createServer(function (req, res) {
    handler(req, res, function (err) {
      res.statusCode = 404;
      res.end('no such location');
    });
  })
  .listen(7777);

handler.on('error', function (err) {
  console.error('Error:', err.message);
});

handler.on('push', function (event) {
  console.log('Received a push event for %s to %s', event.payload.repository.name, event.payload.ref);
  execFunc('sh ./deploy.sh');
});

path就是前面Payload URL的内容，切记，是不包含 host 的，secret就是自己设置的密码。

这里为了方便，写的是单个 webhook 的设置，如果你有多个项目，设置请参考这个。

守护程序

理论上，现在就可以运行了。

1
node app.js

但是，现在的 node-github-webhook 遇到错误是直接抛错的，会终止程序的进行，所以最好采用守护进程去运行，如pm2，forever，我这采用了pm2。

1
pm2 start app.js

反向代理

现在程序是在 7777 端口跑的，需要 Ngnix 反向代理到 80 端口。这里就不展开了。如果不想做，可以直接把Payload URL设置成https://example.com:7777/app，就是看起来不够优雅。

结果

一般来说，如果成功了的话，你的代码就已经更新了。如果你需要看具体的请求内容和返回结果，可以在Webhooks里的Recent Deliveries查看每次请求的内容。