利用github提供的Webhooks实现自动化部署

本文主要介绍利用github提供的Webhooks实现自动化部署

1.配置git SSH 公钥和私钥

可参考:git配置SSH,配置成功之后,服务就能拉取github的代码了

2.配置Webhooks

新建项目=>Settings=>Webhooks
配置项如下:

1
2
3
4
5
6

Payload URL // hook触发的接口地址
Content type // request类型(这里以application/json为例)
Secret // 加密的秘钥
Which events would you like to trigger this webhook // 想要触发的时间,默认选择第一个(push事件)
Active // 是否提供详细信息

3.创建自动化部署Shell脚本(也可以是其他脚本或手段,这里以Shell为例)

1
2
3
4
5
6

#!/bin/bash
cd /opt/...
git pull
...
启动命令

4.编写调用自动化部署Shell的接口(这里以node服务koa2为例,也可以是其他语言服务)

将创建Webhooks时填写的Secret存出在服务器环境变量中(这里以contos7为例)

临时生效:

1
2
3
4

export SECRET_TOKEN=创建Webhooks时填写的Secret

echo $SECRET_TOKEN // 验证是否成功

永久生效:

1
2
3
4
5
6
7
8
9
10
11
12
13

vim /etc/profile

在最后,添加:

SECRET_TOKEN=创建Webhooks时填写的Secret
export SECRET_TOKEN

保存,退出

source /etc/profile

echo $SECRET_TOKEN // 验证是否成功

创建koa2项目并编写调用自动化部署Shell的接口

创建koa2项目,对项目进行常规配置(此处省略500字,这里不属于本文重点介绍的内容,有兴趣请自行Google)

关键代码性代码:

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

const router = require('koa-router')()
const childProcess = require('child_process') // 创建子进程
const crypto = require('crypto') // 加密解密工具

router.post('/url', function (ctx, next) { // 这里的/url必须与配置Webhooks时填写的接口路径相同
const hubSignatureKV=ctx.header['x-hub-signature']
if(hubSignatureKV){
// 获取github签名
const hubSignature=hubSignatureKV.slice(5)
// 获取系统环境变量SECRET_TOKEN
const secret=process.env.SECRET_TOKEN
// 创建一个hmac对象(必须是sha1算法,secret作为加密秘钥)
const hmac = crypto.createHmac('sha1', secret)
// 往hmac对象中添加摘要内容(必须是请求主体,因为Content type配置为application/json,所有此处需要转为json字符串)
const up = hmac.update(JSON.stringify(ctx.request.body))
// 使用 digest 方法生成加密内容(必须是hex格式)
const signature = up.digest('hex')
if(hubSignature===signature){ // 相同则验证成功
childProcess.exec('/opt/shell/hexo.sh',function(err){ // 利用子进程执行系统命令
console.log(err) //当成功是error是null
})
ctx.body = '执行成功'
}else{
ctx.body = '服务器已积极拒绝你的请求'
}
}else{
ctx.body = '服务器已积极拒绝你的请求'
}

})

module.exports = router

5.部署接口服务并验证

将服务部署到服务器(这里案例为node服务,推荐使用pm2守护进程部署)
部署成功之后推送代码验证即可

扫一扫,请老师喝水