博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Node + Git + Webhook 自动化部署
阅读量:6580 次
发布时间:2019-06-24

本文共 4759 字,大约阅读时间需要 15 分钟。

前言

之前断断续续在重构一个项目,然后发现功能一开始设计太多了,可能需要花大量时间来增加,但是核心功能基本完成,于是想着能不能半上线状态,然后通过更新提交git,让服务器部署自动更新。这之前接触过git hook是可以实现的,因此这里记录一篇文章边捣鼓边写。

正文

准备

首先确定需要完成的内容,明确需求:

1.监听指定 git 提交2.执行指定多个脚本

而且因为我这边是需要分别对clientserver 目录分别执行部署命令。所以需要特别处理。

首先去域名管理那边增加一条A记录指向新的项目名称.因为Webhooks是需要外网域名的,因此先提前加一条。new.xxx.com

然后就是需要对服务器上Nginx做转发配置。

我的nginx是很久之前配置的

etc/nginx/conf/vhost里增加一个文件,里面写入如下内容:

server        {                listen 80;                server_name new.xxx.com;                index index.html index.htm index.php default.html default.htm default.php;                location / {                        proxy_pass http://127.0.0.1:8801;                }                access_log off;        }

将本地的8801转发出去。

然后重启一下Nginx nginx -s reload

然后git clone 仓库

因为项目用了mongodb数据库:

需要创建一个对应的数据库并添加权限。

1. 切换数据库到 abc2. 指定了数据库 abc ,拥有权限: userAdmin db.createUser(   {     user: "123",     pwd: "123",     roles: [ { role: "userAdmin", db: "abc" } ]   } ) 3. 验证下上面创建的账号 123 db.auth('123','123') => 1

配置webhook

这个其实是最简单的,只要在你的github对应的项目仓库右侧选择settings

然后选择webhooks

imgn

选择add webhook

然后按照如下配置即可:

imgn

这里需要记住你自己设置的secret 以及你定义的推送动作,我这里是pushCode

开始写脚本

写之前先来看下最终的目录结构:

├── README.md├── clean.sh // 清理缓存,并且执行git命令├── client│   ├── autoClient.sh // client端自动监听│   ├── build│   ├── config│   ├── package.json│   ├── public│   ├── scripts│   ├── src│   ├── tsconfig.json│   ├── tsconfig.test.json│   ├── tslint.json│   ├── www│   ├── yarn.lock├── deploy│   └── index.js // 监听webhook事件然后依次执行 clean.sh autoClient.sh autoServer.sh├── package.json├── server│   ├── autoServer.sh // server端自动监听│   ├── dist│   ├── package.json│   ├── src│   ├── tsconfig.json│   ├── tslint.json│   └── yarn.lock

因为项目原因,脚本还需要做一些定制。

首先是client端,因为前端是用了typescript + React全家桶 所以打包起来特别慢,当在服务器build的时候,因为阿里云内存给的不够,所以会很卡。基于这个考虑,是打算本地bulid完之后,推送到git上,服务器去git pull

而且前端还有个考虑是用什么跑前端代码。因为服务器没装类似服务,因此打算用node框架koa起一个HTTP服务来跑。

代码如下:

www目录中

app.jsconst Koa = require('koa')const morgan = require('koa-morgan')const path = require('path');const static = require('koa-static')const fs = require('fs')const app = new Koa();// loggerapp.use(morgan(':remote-addr - :remote-user [:date[clf]] ":method :url HTTP/:http-version" :status :res[content-length] :response-time ms'));// static assetsapp.use(static(path.join(__dirname,'../build')));//异步读取文件的形式// app.use(async (ctx,next) =>{//     ctx.type = 'html';//     ctx.body = await fs.createReadStream(path.resolve(__dirname, '..', './build', 'index.html'));// })module.exports = app;
index.js'use strict';const app = require('./app');const PORT = process.env.PORT || 8801;console.log('client start')app.listen(PORT, () => {  console.log(`App listening on port ${PORT}!`);});

这样通过命令node ./www/index.js能够监听同级build目录。

当然这比较粗暴,还需要慢慢改进。

我们需要在client目录下建立autoClient.sh

#! /bin/bashcd ./echo 'client build'kill -9 $(lsof -i:8801 |awk '{print $2}' | tail -n 2) node ./www/index.js

用来自动执行监听动作。

因为多次推送监听的前端端口一致,如果不处理会报错。需要先根据端口号8801结束进程然后重新开启服务。

然后是server端,因为整个后端是用koa完成的,项目比较小,在服务端即时编译花费不了多少时间,因此直接执行yarn start( "start": "yarn run build && yarn run watch",)用来编译和监听。

server目录里建立autoServer.sh

#! /bin/bashcd ./echo 'server start'kill -9 $(lsof -i:8866 |awk '{print $2}' | tail -n 2) yarn run start

同样我们需要在执行监听之前结束上一个端口的进程。

然后我们来看clean.sh 这个shell脚本是用来清理client目录下build文件夹。

#! /bin/bashrm rf ./client/buildgit reset --hard origin/mastergit clean -fgit pull

可以看到 先清理了缓存然后再向服务器拉取代码.

最后我们来看部署的脚本deploy/index.js

var spawn = require('child_process').spawnvar http = require('http')var spawn = require('child_process').spawnvar createHandler = require('github-webhook-handler')var handler = createHandler({ path: '/pushCode', secret: 'xxx' }) // 根据git上webhook的配置填写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)})// 监听 push 事件handler.on('push', function (event) {  console.log('Received a push event for %s to %s',    event.payload.repository.name,    event.payload.ref)    init() // 每次拉取都重新监听})function rumCommand( cmd, args, cwd, callback ) {  var child = spawn( cmd, args, {cwd: cwd} )  var response = ''  child.stdout.on('data', function( buffer ){ response += buffer.toString(); })  child.stdout.on('end', function(){ callback( response ) })}function init() {  rumCommand('sh', ['../clean.sh'], './' ,function( result ) { // 清理缓存    console.log(result)  })  rumCommand('sh', ['../server/autoServer.sh'], '../server' ,function( result ) { // cLient端更新    console.log(result)  })    rumCommand('sh', ['../client/autoClient.sh'], '../client' ,function( result ) { // server端更新    console.log(result)  })}init() // 脚本运行第一次默认指向一次

这里需要声明的是因为多目录下执行脚本需要对应的环境。因此才把脚本都分开放。

部署

部署我们只需要对pm2 start deploy/index.js

然后就可以在本地开发完之后推送,服务器就能自动拉取代码并且部署。

转载地址:http://hsino.baihongyu.com/

你可能感兴趣的文章
回忆大学到现在为止学到了什么?
查看>>
润乾报表 - 缓存问题
查看>>
ecshop修改用户登录成功和退出成功的提示页面信息
查看>>
C Cheat Sheet
查看>>
log4j:ERROR Could not read configuration file [log4j.properties].
查看>>
图像处理经典图片Lena背后的故事
查看>>
NSData
查看>>
Design Pattern - 7原则
查看>>
[译] wxWidgets - wxDir
查看>>
gjrand 4.0.1 发布,伪随机数生成器
查看>>
每天一个linux命令(53):route命令
查看>>
使用反射获取Android中隐藏的方法
查看>>
PHP开发者常犯的10个MySQL错误
查看>>
计算图像相似度——《Python也可以》之一(转)
查看>>
Go编程语言规范2-类型
查看>>
对比shrink和move
查看>>
C# Compiler Options
查看>>
Linux学习之CentOS(十七)--与Linux文件和目录管理相关的一些重要命令①
查看>>
The Perfect Stall(二分图匹配,最大流EK算法)
查看>>
字符串处理
查看>>