前言

Github Webhooks 允许我们构建或设置集成，以订阅 GitHub.com 上的某些事件。当触发其中某个事件时，将向 Webhooks 配置 Paloyd URL 发送 HTTP POST 请求。可用于更新外部议题跟踪器、触发 CI 构建、更新备份镜像，甚至部署到生产服务器。

场景

个人博客
如：代码提交远程仓库 => 触发 Github Webhooks => 服务器触发器监听 => 同步更新博客

因本文重点在介绍 webhooks 的自动化功能，我们在此场景的基础上，简化一下步骤，将远程服务器改为本地服务器。如：代码提交远程仓库 -> 触发 Github Webhooks -> 本地服务触发器监听 -> 拉取最新代码

开始

配置 Shell 脚本

创建 blog_deploy.sh 文件

#!/bin/bash

LOG_FILE="/Users/heiemooa/project/code/blog_deploy.log"

date >> "$LOG_FILE"
echo "Start deployment" >>"$LOG_FILE"
echo "pulling source code..." >> "$LOG_FILE"
git clone https://github.com/heiemooa/github-webhooks.git /Users/heiemooa/project/code/heiemooa.github.io
echo "Finished." >>"$LOG_FILE"
echo >> $LOG_FILE

大致意思是，当接收到请求时，会在本地指定目录下，拉取一份最新代码，模拟“服务器同步更新博客”的效果。

搭建本地服务器

创建 index.js 文件

var http = require('http')

const run_cmd = (cmd, args, callback) => {
  var spawn = require('child_process').spawn;
  var child = spawn(cmd, args);
  var resp = "";

  child.stdout.on('data', function(buffer) { resp += buffer.toString(); });
  child.stdout.on('end', function() { callback(resp) });
}

http.createServer(function(req, res) {
  if (req.url === '/webhooks') {
    console.log('监听到接口请求');
    run_cmd('sh', ['./blog_deploy.sh'], () => console.log(1, 'run sucess'));
  }
  res.statusCode = 200;
  res.end('hello world');
}).listen(8080)

console.log('http://localhost:8080')

如上代码，当 HTTP 请求接口为 /webhooks 时，执行同步资源操作。当然，这里仅仅是一个例子，实际场景中需要校验 Method，请求体，Secret 签名 等信息

执行代码，启动端口为 8080 的本地服务

1	$ node index.js

通过 ngrok 实现内网穿透服务

1 2	npm install ngrok -g ngrok http localhost:8080

如上图，本地 localhost:8080 指向了 http://8ffcaa193540.ngrok.io，这么做的目前是为了向互联网暴露本地主机，支持外网访问，也为了下一步 Webhooks 的配置使用，。

当然，除了ngrok，也可以通过 nginx 将当前服务反向代理到指定外网地址的 80 端口。

配置 Github Webhooks

创建一个 Github 仓库，如 github-webhooks。
到 github-webhooks 下 Settings，配置 Github Webhooks 监听，其中
- Payload URL：用来接收请求接口，github 接收到 Repo 的操作指令时，会往这个接口发送一个带有描述操作内容的 Post 请求。这里，我们填写第二步暴露的外网地址，如 http://8ffcaa193540.ngrok.io/webhooks，实际效果 Github 将往本地 8080 端口服务发送一个接口为 /webhooks 的 HTTP 请求。
- Content Type：两种传参方式，application/json 和 application/x-www-form-urlencoded
- Secret：令牌校验，加上这个字段之后，来自 Github 的请求 HTTP 请求头会携带 X-Hub-Signature 的加密签名，防止其他恶意请求触发。

触发 Github Webhooks

往 github-webhooks 远程仓库提交一个 commit，查看是否在本地触发执行 shell 脚本
查看 Recent Deliverles 日志

写在最后

搭建本地服务器那一步，部分网友使用 github-webhook-handler 插件，来处理 Github 发送过来的 HTTP 请求，并监听各类事件，如 push, issues等。

var http = require('http')
var createHandler = require('github-webhook-handler')
var handler = createHandler({ path: '/webhooks', secret: 'myHashSecret' });
// 上面的 secret 保持和 GitHub 后台设置的一致

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

handler.on('error', function (err) {
  console.error('发生错误:', err.message)
})

handler.on('push', function (event) {
  console.log('接收到push请求'）
})