Travis
持续集成,小名CI,分为自动化构建和单元测试,名词吓人,其实就是为了快捷且风险可控地把程序部署到服务器上而存在的。小白听过的CI除了Travis,就是Jenkins,以及GitHub Actions新集成了相应的功能。
考虑起来,我并没有多余的服务器来托管代码,所以选了免费的分布式提供测试环境的Travis。
前期准备
- 一个Github仓库,盛放了本地调试通过的后台程序
- 本地电脑配置GitHub账号的SSH keys,支持免密提交
- 如果要部署,还需要一台服务器(本文针对CentOS 7.6 64位),配置node环境,clone代码仓库且配置GitHub账号的SSH keys
开始整了
从GitHub到Travis 是的,只需要三步:
- 一、在travis-ci.org上以GitHub账户登录,为我们想构建的代码仓库点下开启按钮。
- 二、在项目根目录创建
.travis.yml
。该文件指导CI完成每个构建步骤,简单配置如下:
language: node_js
node_js:
- 10.16.3 # 指定我们的测试环境。注意!!!!本地调试、构建测试、服务上线应使用同一版本
install: npm install --registry=https://registry.npm.taobao.org # 测试前的依赖安装
script: # 启动测试程序
-
三、本地git push,自动触发CI。关注Travis官网内对应项目的构建状态及日志,状态将由黄色(流程中)变为绿色(成功)或红色(失败)。
自此代表我们的程序经过了CI的自动测试,可以有效控制代码质量(想象在一次bugfix面对一堆构建记录,回溯那个出错的原点)。
部署到服务器
实践过程中,ssh免密登录是关键难点,因为我们在登录服务器时输入用户名和密码是和命令行交互的过程,自动部署是做不到的。
除了我采用sshpass的方法,还有一种ssh-copy-id传输本地生成好的密钥,然而我的开发机是Windows系统用不了。
以下下过程在服务器执行
- 安装Ruby环境-> 切换gem源为唯一ruby中国源->
gem install travis
->travis login
- 在项目根目录
travis encrypt DEPLOY_PASS=这里填服务器登录密码 --add
发现.travis.yml多了一段登录密码加密后的密文:
env:
global:
- secure: XXXXXXXXXXX
- 在项目根目录
travis encrypt-file ~/.ssh/id_rsa --add
发现.travis.yml多了一段解密相关的部分:
before_install:
- openssl xxxxx
-in id_rsa.enc -out ~/.ssh/id_rsa -d
还需要补充两句,变为:
before_install:
- openssl xxxxx
-in id_rsa.enc -out ~/.ssh/id_rsa -d
- chmod 600 ~/.ssh/id_rsa
- echo -e "Host 这里填服务器公网IP\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
- 安装sshpass,为.travis.yml添加以下内容:
addons:
ssh_known_hosts:
- 这里填服务器公网IP
apt:
packages:
- sshpass
- 在.travis.yml内写入连接服务器、安装依赖、启动后台程序的命令
给出完整的.travis.yml
language: node_js
addons:
ssh_known_hosts:
- 这里填服务器公网IP
apt:
packages:
- sshpass
branches:
only:
- master # 只有在master改变会触发
node_js:
- 10.16.3
before_install:
- openssl xxxxx
-in id_rsa.enc -out ~/.ssh/id_rsa -d
- chmod 600 ~/.ssh/id_rsa
- echo -e "Host 这里填服务器公网IP\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
install: npm install --registry=https://registry.npm.taobao.org
script: # 启动测试程序
after_success:
- export SSHPASS=$DEPLOY_PASS
- sshpass -e ssh 这里填服务器登录用户名@这里填服务器公网IP -o stricthostkeychecking=no 'cd data-push-app && git pull'
- sshpass -e ssh 这里填服务器登录用户名@这里填服务器公网IP -o stricthostkeychecking=no 'cd data-push-app && sh run_scripts.sh'
env:
global:
- secure: XXXXXXXXXXX
项目根目录新建run_scripts.sh
#!/bin/bash
npm install --registry=https://registry.npm.taobao.org
killall -9 node
nohup npm run start >/dev/null 2>&1 &
本次采用shell脚本启动服务(安装依赖、杀死原服务进程、后台运行node服务)关于杀死进程和静默启动的写法,欢迎指正,可惜没有用pm2管理进程
加上帅气的牌牌
将Travis官网提供的md图片连接添加到我们的README里
小插曲
我试图用process.env.NODE_ENV
区分服务监听的端口,一下是Windows写法:
//package.json
"scripts": {
"dev": "set NODE_ENV=development && node index.js",
"start": "set NODE_ENV=production && node index.js"
}
Linux下export NODE_ENV=设置
//package.json
"scripts": {
"dev": "set NODE_ENV=development && export NODE_ENV=development && node index.js",
"start": "set NODE_ENV=production && export NODE_ENV=production && node index.js"
}