Github webhooks 的使用

• 更多内容,请到我的网站

前提

如果你需要用到github的webhooks功能来实现自动部署, 要求:

• 你的项目在github 管理之下
• 有一个服务器, 提供一条api给github, 他在一些event 完成后调用api, 发起POST 请求, 传递一些参数到api上, 而服务器拿到参数后就可以做自己想做的事

接下来, 直接开始, 假如你在github已经拥有项目(还没有的话请自行创建)

添加webhooks

• 如图,Settings > Webbhooks > Add webhooks

  
  webhooks.png

Payload URL

payloadurl.png events.png

• 有几个功能要解释一下
  • Payload URL: 这条就是给github 帮我们调用的API, 是POST请求
    • e.g: https:xxxxx.com/github/push
  • Content type: 就是content-type, 可以是 x-www-form/application JSON; 这个看你那条api 怎样处理了.
  • Secert: 这个secert, 如果你将ruby -rsecurerandom -e 'puts SecureRandom.hex(20)生成的字符填入 secert. 最后call api 时, github 会将它set 在headers 上给你验证是否为: sha256, 简单说是给你验证是否从github 你这个项目调用的. (非必填)
  • Event: 这个就是要监听github 的什么事件, Push / Create tag 之类的;
    • Let me select individual events 还有不少event.
    • 我选择的是Branch of tag creation, 正常来说, 我们要处理的是create tag 事件, 打 tag后才需要检查是否要自己部署.
  • Active: 简单说你是否需要启用这条webhook

添加后

• 如图

  
  添加.png

详情

• 点击你添加的webhook, 可进入到详情

  
  详情.png

• SSL verification: 如果是你的网站是api 是https, github 会先验证, 也可以disable

测试webhooks

• 进入详情后, 最底下有

  
  状态.png
• 对勾表示成功, 点击某条, 进入详情

Delivery

• 如图, github 调用api 时传入的headers / payload(body)
• Response: 这个是调用Api 的返回, 失败或成功是Api 告诉github 的
• 右边的: Rediliver, 点击后可以再次调用Api, 一般用于超时的失败
  • 个人感觉超时会经常发生,可能是在国内的原因

• 具体要怎么做, 就看服务器怎么做了

  
  99.png

关于本地服务器

• 为了方便本地测试, 下载ngrok, 它可以把你帮本地的服务, 转向成https:xxxx, 一条link.
• 建义在开启ngrok 之前, 先用node/java 开启本地服务, 设置好端口
• ngrok
  • 下载后, unzip, 得到ngrok, 用它运行以下指令(用本地已经开启的端口), 它会生成的链接
  • 根据链接再加上你的 xxxx/xxxx, 就可以设置给github, 方便用于测试
  • 本地在代码, 现在测试打Tag提交. 观察github是否会调用API

$  ngrok http 你的端口

API 处理

• 这里简说一下github 调用我们api, 怎么处理, 其实每个人的处理都不一样.
• 我的处理
  • 我在服务器建立一个pull/build/deploy 的shell, 最后在api 中执行shell 就可以
  • node 环境下执行shell 很简单 (mac)

const childProcess = require('child_process');
childProcess.exec(`bash /.../xxxx.sh`, (error, stdout, stderr) => {
                    if (error) {
                        // 失败
                    } else {
                        // 成功
                    }
})  

• 现在问题是你怎么判断是否执行shell, 执行哪个
• 我的思路是: 打tag 时会有一个描述, 而github中会把那个描述在body中给到API, 所以拿到Tag 时的描述去做文章(这样的好处是特别灵活, 假如你有不同的shell 要执行, 那我们就可以控制描述去执行)~~具体就不多说, 每个人处理不一样.
• 还有一个问题是关于Secert, 这个你可以不设置, 但一定要在服务器上做好判断, 不github 才能调用那条api, 不是谁都可以调用, 出于安全的种种原因.

至此, webhooks 的介绍完毕

参考

• github webhooks
• ngrok document
• 当然github webhooks 的功能远不止这些, 还可以修改playload 之类的,请查看 Webhook events and payloads