如何使用Github的Webhooks+Node完成网站的自动化部署?

自打建立个人博客以来,从最开始的手动部署(纯人工),到通过服务器定时任务自动拉去最新代码部署(不及时),通过jenkins构建,到现在的通过github的webhooks自动化部署,并做此文章以记录...

目前我个人博客网站的部署方式,是通过github的webhooks监听push事件来触发远程服务器的自动化部署脚本,如下:

本地环境->push到github仓库->触发远程自动化部署脚本->网站更新为最新的代码

1.配置github代码仓库的webhook

9gzCC7

如上图进入到项目仓库的settings下面,选中Webhooks选项进行配置即可:

Payload Url:服务器地址+端口+自定义接口地址

Content type: application/json

Secret: 自定义

Which events would you like to trigger this webhook?

勾选 Just the push event

勾选 Active

配置好个选项后,点击Update webhook按钮即可。

2.服务器新增监听push事件的js脚本

定义服务脚本:deploy.js

deploy.js源码如下:

var http = require('http')
var createHandler = require('github-webhook-handler')
var handler = createHandler({ path: '/webhook', secret: '自定义' })

function RunCmd(cmd, args, cb) {
  var spawn = require('child_process').spawn;
  var child = spawn(cmd, args);
  var result = '';
  child.stdout.on('data', function(data) {
    result += data.toString();
  });
  child.stdout.on('end', function() {
    cb(result)
  });
}

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);
  var shpath = './blog-start.sh';
  RunCmd('sh', [shpath], function(result) {
      console.log(result);
  })
})

handler.on('issues', function (event) {
  console.log('Received an issue event for %s action=%s: #%d %s',
    event.payload.repository.name,
    event.payload.action,
    event.payload.issue.number,
    event.payload.issue.title);
})

js脚本使用到了github-webhook-handler的一个组件,可以通过: npm install -g github-webhook-handler来全局安装该组件,安装完组件后,直接启动该脚本时可能会遇到找不到该组件的错误,此时进入deploy.js脚本所在的目录下面执行:npm link github-webhook-handler

脚本中的secret需要跟刚才在github的webhook中secret的值一致。blog-start.sh是我博客的的启动脚本,稍后会展示源码。

脚本中的这段代码:

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

是创建服务,并监听7777端口,这个端口可以根据个人情况自行调整。

2.2 定义启动脚本

下面是blog-start.sh脚本的源码,仅供参考:

## 进入博客目录
echo '进入博客目录'
cd /myblog/Stabber-Blog
## 拉取最新代码
echo '开始拉去最新代码'
git pull
## 打包静态文件
echo '开始构建静态文件'
bundle exec jekyll build
echo '最新文章处理完成'

进行完以上步骤后,可以启动deploy.js脚本,执行以下指令,后台启动脚本:nohup node deploy.js > deploy.log &

2.3 配置nginx,做请求转发

因为为了服务器的安全性,服务器的7777端口我并未对外开放,此时需要配置服务器的nginx服务来转发对应的请求,配置参考如下:

server {
        listen       80;
        server_name  www.itstabber.com;
  ...
            location /webhook {
                proxy_pass http://localhost:7777/webhook;
        }
}

重启nginx是的配置生效: ./nginx -s reload

3. 验证配置结果

到此,当对应的代码仓库有新的push内容后,就回自动触发node启动的js脚本服务,并且通过blog-start.sh自动的从github拉去最新的代码并完成代码构建,此时我的博客内容就会加入最新新增的文章信息了。下面截图是我本片文章新增时的验证结果(截图内容都是提交后补充的):

提交本文章内容

DUPHLj

查看webhook调用结果

进入github项目仓库的webhooks目录下,可以看到本次push触发了接口调用,接口返回:

GmV3AV

查看服务器监听脚本日志

image-20200325003634556

日志显示已经自动拉取刚刚提交的文章,并且重新构建完成

访问博客网站,进行结果验证

image-20200325005159802

截图中可以看到,文章已经发布到网站上了。
如果本文对你有所帮助,请不要吝啬给个点赞,你们的认可是我创作分享的最大动力,谢谢支持!
看完文章后尝试自己配置的小伙伴们,如果又遇到什么问题,可以在文章下方评论区留言交流。
更多文章请访问我的个人博客:技术小白成长之路

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容