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

最新推荐文章于 2025-11-22 02:10:19 发布

转载最新推荐文章于 2025-11-22 02:10:19 发布 · 1.1k 阅读

文章标签：

#gitlib #自动部署 #Webhooks

持续集成专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何利用GitHub的Webhooks功能实现代码推送后的自动部署。通过编写shell脚本和Node.js服务，配置Webhooks以监听push事件，并在事件触发时自动更新代码并构建项目。

前言

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

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

自动部署脚本

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

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

#!/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'

bash

脚本大概的作用就是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。

安装

npm install node-github-webhook --save

入口文件app.js

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')
})