本文,博主将会介绍利用Travis CI持续集成服务自动化构建和部署GitBook。
首先介绍一下TravisCI,下文摘自维基百科-Travis CI
Travis CI是在软件开发领域中的一个在线的,分布式的持续集成服务,用来构建及测试在GitHub托管的代码。这个软件的代码同时也是开源的,可以在GitHub上下载到,尽管开发者当前并不推荐在闭源项目中单独使用它。
闲话少说,直接上配置流程。
配置GitHub Token
利用GitHub Token,Travis CI才有权限访问你在GitHub上的仓库,所以不要轻易将Token泄露。
进入https://github.com/settings/tokens,生成用于Travis CI的Token,其中权限的勾选,酌情勾选,博主全部勾选。
配置Travis CI
同步账号
在进入https://travis-ci.org进行配置前,你需要将你的项目推送到GitHub上,比如博主这里推送到TravisCIStudy的仓库,然后在Travis CI网站同步你的账号。
Travis CI仓库设置
同步完仓库后,在右侧列表找到仓库,打开按钮,并点击Settings
进入仓库设置。
1. 仓库设置项说明
进入后,可以看到总共有四部分设置区域:
设置名 | 解释说明 |
---|---|
General | 通用设置,关于是否构建分支等 |
Auto Cancellation | 自动取消,关于是否自动取消构建分支等 |
Environment Variables | 环境变量,填写Token |
Cron Jobs | 定时任务,修改任务执行频率和条件 |
2. 环境变量填写
前两部分设置,按照默认即可,Environment Variables
中填写刚刚生成的GitHub Token,下图所示。
注意:
由于Travis CI适用于公共仓库,并且Travis CI构建和部署的日志也是对外公开的,所以最好不要将
Display value in build log
按钮打开
3. 定制任务设置
在定时任务中,可以选择任务执行的分支;间隔:每月、每周亦或是每天;选项中,可以选择是否总是执行,或是在24小时内只执行一次。选择完成后,按添加即可。
到这里GitHub和Travis CI仓库连接的相关参数配置完成,现在只要在项目的根目录添加.travis.yml
文件后,推送到远程仓库后,Travis CI服务检测到有该文件,便会自动执行任务。那么.travis.yml
配置文件该怎么配置呢,请看下文所述。
编写.travis.yml配置文件
直接上配置文件说明
# 指定环境语言
language: node_js
# 指定sudo权限
sudo: required
# 指定node版本
node_js: stable
# 指定缓存模块,缓存可以加速编译
cache:
directories:
- node_modules
# 邮件通知,这里配置不管成功或是失败都通知
notifications:
email:
recipients:
- taylortaurus0517@gmail.com
- yuanzheng0517@foxmail.com
on_success: always # default: change
on_failure: always # default: always
# 构建的分支
branches:
only:
- gitbook
# 调整时区
before_install:
- export TZ='Asia/Shanghai'
# 安装环境
install:
- npm install -g gitbook-cli
- gitbook install
# gitbook生成静态文件
script:
- gitbook build
# 生成文件后,进入静态文件目录,部署到指定仓库,需要填写用户名,邮件
after_script:
- cp ./seo/* ./_book/
- cd ./_book
- git init
- git config user.name "taylortaurus"
- git config user.email "taylortaurus0517@gmail.com"
- git add .
- git commit -m "Update GitBook By TravisCI With Build $TRAVIS_BUILD_NUMBER"
- git push --force --quiet "https://${GH_TOKEN}@${GH_REF}" master:master
- git push --force --quiet "https://taylortaurus:${CO_TOKEN}@${CO_REF}" master:master
# 环境变量
env:
global:
# Github Pages
- GH_REF: github.com/taylortaurus/TravisCIStudy
# Coding Pages
- CO_REF: git.coding.net/taylortaurus/TravisCIStudy.git
终
至此,所有的配置均完成,现在只要将.travis.yml
配置文件推送到远程仓库,静等结果。
小彩蛋
问:既然Travis CI可以自动构建和部署GitBook,为什么没在GitHub上看到你使用Travis CI构建和部署你的博客呢?
答:因为正如前文所提到的,Travis CI适用于公共仓库,由于博客中涉及一些秘钥所以换成了GitLab CI,毕竟GitLab不限制私有库数目,还自带CI。不是美滋滋?