github自动部署

发表于 | 分类于 |
通过node.js+webhook 实现github的自动部署

以下命令,均是在Debian系统环境下,若是其他系统,使用对应系统命令即可

安装node.js版本8.x

1
2
sudo curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

我这里新建了一个目录作为自动部署服务的根目录,并进入该目录

1
2
mkdir /home/webhook;
cd /home/webhook;

在当前文件夹下,新建一个deploy.js作为监听程序,内容如下

以下文件已上传gist 可使用命令

1
sudo curl -O https://gist.githubusercontent.com/oryxtc/b0bb50c210e25207dc67132d778714b6/raw/0b75f714064e232594fbaaf0f753bc9bf25d43df/deploy.js

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
var http = require('http')
var createHandler = require('github-webhook-handler')
var handler = createHandler({ path: '/', secret: 'your-secret' }) 
// 上面的 path 即是github中填写的url的path部分
// 上面的 secret 保持和 GitHub 后台设置的一致
 
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) {
  res.statusCode = 404
  res.end('no such location')
  })
}).listen(7777)
// listen(7777)指监听7777端口,可以根据实际情况改成你自己的
 
handler.on('error', function (err) {
    console.error('Error:', err.message)
})
 
handler.on('push', function (event) {
 var name=event.payload.repository.name;
 console.log('Received a push event for %s to %s',
    event.payload.repository.name,
    event.payload.ref);
  //如果是notebook 则为hexo自动部署进入mybloy(根据自己情况修改文件夹名)
  if(name==='notebook'){
      run_cmd('sh', ['./deploy_hexo.sh','myblog'], function(text){ console.log(text) });
  }else {
      run_cmd('sh', ['./deploy.sh',name], function(text){ console.log(text) });
  }
})
//这里为了实现不同仓库的自动部署,传了仓库名给shell脚本 

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

在当前文件夹下新建一个deploy.sh脚本执行自动拉取,内容如下

以下文件已上传gist 可使用命令

1
sudo curl -O https://gist.githubusercontent.com/oryxtc/3850a573f0b6a0e7eb783658863d08cb/raw/0750ad8eb8c1feed24d07fb0f1f11a7baa07a212/deploy.sh

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
WEB_NAME="$1"
WEB_PATH='/home/www/'${WEB_NAME}
WEB_USER='root'
WEB_USERGROUP='root'

echo "Start deployment"
cd $WEB_PATH
echo "pulling source code..."
git checkout master
git reset --hard origin/master
git clean -f
git pull origin master

#echo "changing permissions..."
#chown -R $WEB_USER:$WEB_USERGROUP $WEB_PATH;
echo "Finished."

在当前文件夹下新建一个deploy_hexo.sh脚本执行自动拉取,以及hexo部署和提交.(根据自己情况 修改路径等)

以下文件已上传gist 可使用命令

1
sudo sudo curl -O https://gist.githubusercontent.com/oryxtc/eac1ec324ed295cddcae7c6767bc09f8/raw/09f97c4978e4336a139894d6a99b7d2d4513553b/deploy_hexo.sh

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
WEB_NAME="$1"
WEB_PATH='/home/www/'${WEB_NAME}
WEB_SOURCE_PATH=${WEB_PATH}'/source/_posts'
WEB_USER='root'
WEB_USERGROUP='root'

echo "Start deployment"
cd $WEB_SOURCE_PATH
echo "pulling source code..."
git checkout master
git reset --hard origin/master
git clean -f
git pull origin master

#chown -R $WEB_USER:$WEB_USERGROUP $WEB_PATH;
#echo "changing permissions..."
#chown -R $WEB_USER:$WEB_USERGROUP $WEB_PATH;
echo "start hexo deployment"
cd $WEB_PATH
hexo d -g

#if you have hexo algolia component
echo "start algolia deployment"
hexo algolia
echo "Finished."

这里要注意,如果是在Windows环境下编写文件,换行符会跟linux不一样!要用编辑器转换成UNIX格式

这里需要用到node.js的中间件github-webhook-handler,安装到当前目录下

1
sudo npm install github-webhook-handler

为了自动部署能后台自动运行,并且断线自动重运行,这里使用pm2组件

1
sudo npm install -g pm2

如果出现 /usr/bin/pm2 -> /usr/lib/node_modules/pm2/bin/pm2
使用软连接 ln -s /usr/lib/node_modules/pm2/bin/pm2 /usr/bin/pm2

用pm2运行该进程

1
sudo pm2 start deploy.js --name auto-deploy # 命名进程

最后在github的项目中配置webhook