github管理项目 使用 webhooks 实现推送，服务器实时自动部署

首先我们要考虑的一个问题是，git推送，服务器实时部署的原理是什么？

如下图

主要的流程过程

本地代码push → 远程库发起请求 → 服务器更新

那么流程是这样一个流程，具体的我们该如何实现呢？

一、配置 github ，监听推送向指定的服务器端口发起 push 行为

首先还是打开我们要监听的 github 地址，找到 settings 设置

找到左侧选项的 webhooks 选项，新增一个推送监听项，而这个监听项也就是向服务器发送一个 push ，而对应的服务器也可以接收到这个 push ，那么我们就可以根据这个 push 去执行一些事情，实现服务器的自动部署。


创建完成之后那么在 webhooks 列表页也就有了一项我们刚刚配置的请求 push 项

那么这个时候我们 github 需要操作的步骤也就完成了

二、配置服务器，安装 git ，node ，pm2

准备工作

在这边也是推荐给大家安装一下宝塔面板就不需要手动的去安装配置node了，可以参考下方链接。

Linux系统安装宝塔面板

安装好宝塔面板之后 会给你一个账号密码

安装成功之后我们也可以使用 这行代码进行查看账号密码

/etc/init.d/bt default

打开对应的外网地址 输入上方的用户名密码 进入到指定的页面

这个时候我们就可以下载对应的 PM2 管理器，里面也同时夹带了 node 以及 pm2 ，当然我们还需要做的一步操作是要把 github 配置的 push 端口放开，因为安装宝塔的同时也为我们开启了防火墙。

接下来我们需要安装 git ，我这边使用的系统是 Ubuntu 同时的大家可以根据自己的 linux 系统进行查找配置安装

sudo apt-get install git

安装好git之后进行命令配置，大家可以自行查找

三、启动 node 服务器，执行 sh 文件

自己在服务器定义一个文件夹，我的项目都是放在了 www 里面的，我这边就是进入到 www 文件下之后，在内部新建了一个webhooks文件夹。

最先的进入到文件夹后我们需要做的还是

npm init -y // 初始化
npm i github-webhook-handler // 安装 github webhook监听工具

接下来我们需要新建两个文件

gitupdate.js

var http = require('http')
var createHandler = require('/www/webhooks/node_modules/github-webhook-handler')
// secret:填写 github 配置的密码  path设置成 / 即可
var handler = createHandler({ path: '/', secret: 'password' })

function 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) {
  handler(req, res, function (err) {
    // 断开请求
    console.log('请求过来了，不要走了！')
    res.statusCode = 404
    res.end('no such location')
  })
}).listen(4000,function(){
  console.log((new Date()) + '我启动起来了', 4000);
})

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)
    // 监听到 push 执行 sh 文件夹
    run_cmd('sh', ['./deploy.sh',event.payload.repository.name], function(text){ console.log(text) });
})

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

deploy.sh

# WEB_PATH 填写对应的要自动更新的地址 其实就是进入的那个文件夹下
WEB_PATH='/www/projects/'tinkerbell-ui
WEB_USER='root'
WEB_USERGROUP='root'

echo "Start deployment"
# 此步进入到上方的填写的文件夹下
cd $WEB_PATH
echo "pulling source code..."
# 执行三步拉取操作
git reset --hard origin/main
git clean -f
git pull
echo "changing permissions..."
chown -R $WEB_USER:$WEB_USERGROUP $WEB_PATH
echo "Finished."

配置完成之后这个时候我们就可以使用 pm2 运行我们的项目了

pm2 start gitupdate.js --name tinkerbell-ui

那么这个时候自动部署也就成功了