Travis CI 使用详解

发表于 | 更新于 | 分类于 ， | 评论数： | 阅读次数：

本文列举了使用 Travis CI 可能遇到的问题及其解决方法。

官方网站：https://travis-ci.com

官方文档：https://docs.travis-ci.com/

更新说明

注册登录

在 https://travis-ci.com 直接通过 GitHub 登录。

项目同步

目前，travis 仅支持构建 GitHub 项目。

登录之后点击右上角用户名，再点击左上的 Sync account 来同步 GitHub 项目。

如果你名下的 GitHub 组织没有显示，请点击左下 Review and add 重新授予权限。

安装 Travis CI GitHub App。

使用 Travis CI

在 Git 项目根目录增加 .travis.yml 文件，即可开始使用 travis， travis 会在项目每次提交（push），PR，tag 时自动构建项目。

使用示例

构建变量（环境变量）

在每个项目的设置页面中，通过 K-V 形式设置环境变量。

变量分为加密变量（构建过程不可见）和普通变量。

加密变量在构建项目中他人的 PR 时将不能被使用。在构建项目内不同分支的 PR 时可以使用。这一点需要注意：

例如，项目的 dev 分支向 master 分支提交 PR，构建 PR 时就可以使用加密变量。

他人向 dev 分支提交 PR，构建 PR 时就不能使用加密变量。

命令行工具

安装 Travis CI 命令行工具

1
2
3
4
5
6
$ sudo gem install travis

# 登录
# github-token 在 GitHub 设置页面生成，当然也可以使用密码登录

$ sudo travis login --github-token 0abc23...

SSH

我们现在要让 Travis CI 能够通过 SSH 登录到 服务器，就将 ~/.ssh/id_rsa 「加密复制」 到 Travis CI。

加密 id_rsa

进入项目根目录执行：

1
$ travis encrypt-file ~/.ssh/id_rsa --add

请根据实际修改 SSH 密钥文件名，一般默认为 id_rsa。

解密 id_rsa

命令执行之后，自动生成了 id_rsa.enc 文件，并自动在 .travis.yml 增加如下内容：

1
2
3
before_install:
- openssl aes-256-cbc -K $encrypted_023c3608ff03_key -iv $encrypted_023c3608ff03_iv
  -in id_rsa.enc -out ~\/.ssh/id_rsa -d

注意：请将上述内容的 转义符 去掉: -out ~\/.ssh/id_rsa -d 改为 -out ~/.ssh/id_rsa -d

ssh_known_hosts

首次 SSH 到某网址或 IP 需要输入 yes 来确认，你可以在 .travis.yml 文件中增加 ssh_known_hosts 来避免输入 yes

1
2
3
4
5
6
7
8
after_success:
  - scp README.md ubuntu@123.206.62.18:~

addons:
  ssh_known_hosts:
  - 123.206.62.18
  - code.aliyun.com
  - github.com

构建规则

指定分支构建

1
2
3
4
5
6
7
8
9
10
branches:
  only:
  - master
  - /.*/
  - /^deploy-.*$/

branches:  
  except:
  - legacy
  - experimental

这样 travis 只会构建 master 分支，dev 等其他分支提交(push)时不会构建。

部署

GitHub Pages

1
2
3
4
5
6
7
8
9
10
11
deploy:
  provider: pages
  # 要 push 的文件夹
  local-dir: _book
  # pages 所在分支
  target-branch: master
  skip-cleanup: true # 若为 false （默认） 会运行 `git stash -all` 把 git 目录中更改的藏起来
  # 意味着 在 deploy 之前会把 git 恢复到初始状态，所以当提交对象（新生成）在 git 仓库中，必须设置为 true，具体原理请查看 `git stash`
  github-token: $GH_TOKEN # Set in travis-ci.org settings
  on:
    branch: gitbook       # 哪个分支构建的就推送

script

1
2
3
4
5
6
deploy:
  provider: script
  script: .travis/deploy.sh
  skip-cleanup: true
  on:
    branch: gitbook

缓存 Cache

1
2
3
cache:
  directories:
  - node_modules

编程语言

在 .travis.yml 文件开头首先指明编程语言

1
2
3
language: php

os: osx

请查看 官方文档

加密文件

https://docs.travis-ci.com/user/encrypting-files/

构建生命周期

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
language: php

os:
  - linux
  - osx

services:
  - docker
  - mysql

cache:
  directories:
  - vendor

git:
  depth: 3
  depth: false
  submodules: false

addons:
  apt:
    sources:
      - deadsnakes
      - sourceline: 'ppa:ubuntu-toolchain-r/test'
      - sourceline: 'deb https://packagecloud.io/chef/stable/ubuntu/precise main'
        key_url: 'https://packagecloud.io/gpg.key'
  hosts:
    - travis.test
    - joshkalderimis.com
  ssh_known_hosts:
    - 123.206.62.18
    - code.aliyun.com
    - github.com

matrix:
  include:
    - os: linux
      dist: xenial
      env: K=V
    - os: osx
  allow_failures:
    - php: master
  fast_finish: true

env:
  global:
    - TZ=Asia/Shanghai
  matrix:
    - APP_ENV = pro
    - APP_ENV = dev
    - APP_ENV = staging

# env:
#   - APP_ENV = pro
#   - APP_ENV = dev
#   - APP_ENV = staging

php:
  - 5.6
  - 7.0
  - 7.1
  - 7.2

before_install:
  - sudo apt-get update -qq

# 安装构建依赖
install:
  - composer install -q

before_script:    
# 执行构建步骤

script:
  - env  

after_script:  

# 构建成功之后执行的步骤
after_success:

# 构建失败之后执行的步骤
after_failure:
before_cache:
before_deploy:
deploy:
after_deploy:

jobs:
  include:
    - stage: test
      script:
    - stage: deploy
      script:

# 指定 jobs 顺序，构建条件
#
# @see https://docs.travis-ci.com/user/conditional-builds-stages-jobs/  
stages:
  - test
  - name: deploy
    if: tag =~ ^[0-9.]+$

# blocklist
branches:
  except:
  - legacy
  - experimental

# safelist
branches:
  only:
  - master
  - stable
  - /^deploy-.*$/

其他

错误排查

Travis CI 本质就是一台云上的 Linux（虚拟机），当执行错误时从以下两方面排查问题:

  • 注意容器运行环境已废弃，即现在的构建环境都是在虚拟机中。

  • 路径问题(使用 $ echo $PWD 调试)

  • 权限问题(没有执行权限 $ chmod +x filename.sh)

时区

1
2
before_install:
- export TZ='Asia/Shanghai'

相关链接

0%