什么是持续集成?
Travis CI 提供的是持续集成服务(Continuous Integration,简称 CI)。它绑定 Github 上面的项目,只要有新的代码,就会自动抓取。然后,提供一个运行环境,执行测试,完成构建,还能部署到服务器。
持续集成指的是只要代码有变更,就自动运行构建和测试,反馈运行结果。确保符合预期以后,再将新代码"集成"到主干。
持续集成的好处在于,每次代码的小幅变更,就能看到运行结果,从而不断累积小的变更,而不是在开发周期结束时,一下子合并一大块代码。
The goal is to build healthier software by developing and testing in smaller increments. This is where Travis CI comes in.
我们的目标是通过以较小的增量开发和测试来构建更健康的软件。 这就是 Travis CI 的用武之地。
Travis 要求项目的根目录下面,必须有一个.travis.yml
文件。这是配置文件,指定了 Travis 的行为。该文件必须保存在 Github 仓库里面,一旦代码仓库有新的 Commit,Travis 就会去找这个文件,执行里面的命令。
这个文件采用 YAML 格式。下面是一个最简单的 Python 项目的.travis.yml
文件。
language: python script: true
上面代码中,设置了两个字段。language
字段指定了默认运行环境,这里设定使用 Python 环境。script
字段指定要运行的脚本,script: true
表示不执行任何脚本,状态直接设为成功。
Travis 默认提供的运行环境,请参考官方文档 。目前一共支持31种语言,以后还会不断增加。
下面是一个稍微复杂一点的.travis.yml。
language: python sudo: required before_install: sudo pip install foo script: py.test
上面代码中,设置了四个字段:运行环境是 Python,需要sudo权限,在安装依赖之前需要安装foo模块,然后执行脚本py.test。
运行流程
Travis 的运行流程很简单,任何项目都会经过两个阶段。
install 阶段:安装依赖
script 阶段:运行脚本
install 字段
install字段用来指定安装脚本。
install: ./install-dependencies.sh
如果有多个脚本,可以写成下面的形式。
install: - command1 - command2
上面代码中,如果command1失败了,整个构建就会停下来,不再往下进行。
如果不需要安装,即跳过安装阶段,就直接设为true。
install: true
script 字段
script字段用来指定构建或测试脚本。
script: bundle exec thor build
如果有多个脚本,可以写成下面的形式。
script: - command1 - command2
注意,script与install不一样,如果command1失败,command2会继续执行。但是,整个构建阶段的状态是失败。
如果command2只有在command1成功后才能执行,就要写成下面这样。
script: command1 && command2
实例:Node 项目
Node 项目的环境需要写成下面这样。
language: node_js node_js: - "8"
上面代码中,node_js
字段用来指定 Node 版本。
Node 项目的install
和script
阶段都有默认脚本,可以省略。
install
默认值:npm install
script
默认值:npm test
更多设置请看官方文档。
部署
script
阶段结束以后,还可以设置通知步骤(notification)和部署步骤
(deployment),它们不是必须的。
部署的脚本可以在script
阶段执行,也可以使用 Travis 为几十种常见服务提供的快捷部署功能。比如,要部署到 Github Pages,可以写成下面这样。
deploy: provider: pages skip_cleanup: true github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard on: branch: master
其他部署方式,请看官方文档。
完整的生命周期,从开始到结束是下面的流程。
before_install install 阶段之前执行 install before_script script aftersuccess or afterfailure [OPTIONAL] before_deploy [OPTIONAL] deploy [OPTIONAL] after_deploy after_script script 阶段之后执行
运行状态
最后,Travis 每次运行,可能会返回四种状态。
passed:运行成功,所有步骤的退出码都是0 canceled:用户取消执行 errored:before_install、install、before_script有非零退出码,运行会立即停止 failed :script有非零状态码 ,会继续运行
使用技巧
环境变量
.travis.yml
的env
字段可以定义环境变量。
env: - DB=postgres - SH=bash - PACKAGE_VERSION="1.0.*"
然后,脚本内部就使用这些变量了。
有些环境变量(比如用户名和密码)不能公开,这时可以通过 Travis 网站,写在每个仓库的设置页里面,Travis 会自动把它们加入环境变量。这样一来,脚本内部依然可以使用这些环境变量,但是只有管理员才能看到变量的值。具体操作请看官方文档。
image
5.2 加密信息
如果不放心保密信息明文存在 Travis 的网站,可以使用 Travis 提供的加密功能。
首先,安装 Ruby 的包travis
。
$ gem install travis
然后,就可以用travis encrypt
命令加密信息。
在项目的根目录下,执行下面的命令。
$ travis encrypt SOMEVAR=secretvalue
上面命令中,SOMEVAR
是要加密的变量名,secretvalue
是要加密的变量值。执行以后,屏幕上会输出如下信息。
secure: ".... encrypted data ...."
现在,就可以把这一行加入.travis.yml
。
env: global: - secure: ".... encrypted data ...."
然后,脚本里面就可以使用环境变量$SOMEVAR
了,Travis 会在运行时自动对它解密。
travis encrypt
命令的--add
参数会把输出自动写入.travis.yml
,省掉了修改env
字段的步骤。
$ travis encrypt SOMEVAR=secretvalue --add
详细信息请看官方文档。
参考
持续集成服务 Travis CI 教程 - 阮一峰的网络日志
http://www.ruanyifeng.com/blog/2017/12/travis_ci_tutorial.html