使用nodejs实现模拟jenkins打包发布vue项目工程

前端工程化的今天,版本发布已经成为开发中的重要一环。

很多项目开发中都开始使用jenkins来做自动发版工作。

不过jenkins复杂的安装配置比较不容易上手,而且很多环境是不适用安装jenkins来做自动发版的。

我模拟Jenkins逻辑写了一个node版本的自动发版的程序。带大家了解一下自动发版的基本原理。同时,如果需要的朋友也可以直接上手来使用。

仓库地址和使用方式

使用方式:

> git clone https://github.com/shb190802/node-jenkins.git
> cd node-jenkins
> npm install
> node app.js

浏览器访问YOUR_IP_ADDRESS:3011

需求分析

首先分析,如果要做到自动发版需要实现哪些功能。

  1. 从相应仓库下载要发布的分支代码
  2. 编译代码
    • 设置npm源
    • 安装依赖
    • 执行编译命令
  3. 将编译后的代码发布到服务器指定目录

技术实现

1、从相应仓库下载要发布的分支

此处使用download-git-repo,来完成从相应仓库下载要发布的分支代码。放置在一个临时目录下。

// 示例方法
let repository = `direct:${this.repo}#${this.branch}`
download(repository, destination, options, callback)

2、编译代码

编译代码我们使用child_process.exec来执行命令行命令来执行

// 示例方法
const COMMAND = ['npm config set registry http://registry.npm.taobao.org/', 'npm install', 'npm run build']

for (let i = 0, len = COMMAND.length; i < len; i++) {
    await this.exec(COMMAND[i]) // 需要在async函数中
}

3、将编译后代码发送到服务器对应目录

这里使用到ssh2-sftp-client

// 示例方法
let client = new Sftp()
console.log('连接web服务器'.yellow)
await client.connect({
    host: this.host,
    username: this.username,
    password: this.password
})
console.log(`mkdir ${this.remotePath}`.green)
await client.mkdir(this.remotePath, true)
console.log(`传输文件【${localPath}】===>【${this.remotePath}】`.green)
await client.uploadDir(localPath, this.remotePath) // 将本地文件夹传输到远程
console.log('文件传输完毕'.green)
client.end()

4、项目优化

前三步已经完成一个自动下载、打包、发布的流程。

我们可写出一个js文件,使用命令行工具【node+filename.js】来做到本机自动发版。

但是项目还有很多可以优化的地方。

(1)将编译选项抽象成配置项

将配置选项从代码中抽象出来,我们将发版程序做的更加独立。

{
    /** build config */
    name: '聊天室 客户端',
    repo: 'https://github.com/shb190802/chat.git', // 仓库地址
    branch: 'master', // 编译分支 默认master
    srcPath: 'client', // 项目编译目录,一般是vue.config.js所在目录
    buildCommand: ['npm config set registry http://registry.npm.taobao.org/', 'npm install', 'npm run build'],
    outputPath: 'server/static/html', // 编译目录 默认是srcPath下 dist
    /* host config */
    remotePath: '/usr/local/nginx/html/html', //YOUR_REMOTE  web项目远程目录 注意,由于会提前清空远程目录。请慎重填写地址
    host: '', // YOUR_HOST  web服务器IP地址
    username: '', // YOUR_NAME
    password: '' // YOUR_PWD
}

(2)重复使用node_modules

node的依赖安装,占到了打包的很大一部分时间。

我在这里处理方式是:

从仓库下载代码之前,先判断是否已经有过安装的node_modules目录。

如果有,就将它转移到一个临时目录。等待代码下载完成之后。在转移到编译目录下。

5、使用koa创建一个server端,给局域网内其他同事提供打包服务

即时完成了前边步骤,我们也还只是一个单机版的发版程序。

最后,我们使用koa建立一个简单的website。发布局域网内的同事。

静态页面和serviceApi的开发,此处就不在赘述了。

最终项目效果:

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