模板整理之Travis CI

官方文档

免费 Travis-CI（针对开源项目）：https://travis-ci.org

收费 Travis-CI（针对私有和商业项目）：https://travis-ci.com

使用步骤

  1. 登录 Travis CI 并对指定的项目启用。
  2. 配置 .travis.yml ，参考官方文档。
  3. push（或其他方式）触发 Travis-CI。

实现工作流

  1. 构建。开发一些新功能，提交代码后自动构建出一个 APK（可以是测试版，也可以是发布版）。
  2. 部署。将 APK 上传到 Github Release / Fir.im / 蒲公英等。
  3. 通知。发出通知（邮件、消息等形式）。

构建

release 签名证书安全

Android 项目发布需要证书文件、密码、别名、别名密码。无论是开源项目还是私有项目，任何时候都不应该将原始证书或密码放入代码库（原则上来讲证书和密码也不应该交于开发人员，而应该只能通过发布服务器进行编译）

Travis CI 为此提供了 2 种解决方案：

  1. 对敏感信息、密码、证书等进行对称加密，在 CI 构建环境时解密。
  2. 将密码等通过 Travis CI 控制台设置为构建时的环境变量。

个人倾向使用第二种方案，但 Travis CI 控制台无法上传文件，因此涉及到文件加密的部分，选择第一种方案。

加密证书文件：
  1. 本地安装 Travis CLI 命令行工具。
1
gem install travis

这一步如果遇到错误, 尝试加 sudo，请升级一下 ruby 版本。

  1. 命令行登录 Travis（第一次登录才要），并输入 GitHub 的用户名和密码。

针对免费版 https://travis-ci.org：

1
travis login --org

针对收费版 Travis-C https://travis-ci.com：

1
travis login --pro

这一步如果遇到 travis 命令找不到, 尝试找到 travis 安装的 bin 目录，并配置上环境变量。

  1. 进入项目根目录，加密证书。
1
travis encrypt-file XXX.jks --add

命令执行结果：

  1. 在 Travis CI 控制台自动生成一对秘钥。
  2. 基于秘钥通过 openssl 对文件进行加密，并在根目录生成 XXX.jks.enc 文件。
  3. 在 .travis.yml 中自动生成 Travis CI 环境下解密文件的配置。
1
2
3
before_install:
  - openssl aes-256-cbc -K $encrypted_cd91ae131fae_key -iv $encrypted_cd91ae131fae_iv
    -in mrd@vdreamers.enc -out mrd@vdreamers -d
加密证书密码

在 Travis CI 控制台配置证书密码、证书别名、证书别名密码三个环境变量（KEYSTORE_PWD、KEYSTORE_ALIAS、KEYSTORE_ALIAS_PWD）。

实现本地和 Travis-CI 构建 release 包互不干扰

基本思路，判断环境变量 CI 是否 为 true，通过 System.getenv(“CI”) 去获取环境变量 CI 的值，fals e 即为本地构建，true 即为 Travis-CI 构建。
本地构建去 local.properties 中读取证书配置；Travis-CI 构建通过 System.getenv 去读取环境变量的证书配置。

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
apply plugin: 'com.android.application'

def keystorePWD = ''
def keystoreAlias = ''
def keystoreAliasPWD = ''
// local.properties file in the root director
def keyFile = project.rootProject.file('local.properties')

Properties properties = new Properties()
// local.properties exists
if (keyFile.exists()) {
    properties.load(keyFile.newDataInputStream())
} else {
    keyFile = file("../no_exists_keystore.tmp")
}

// local.properties contains keystore.path
if (properties.containsKey("keystore.path")) {
    keyFile = file(properties.getProperty("keystore.path"))
    keystorePWD = properties.getProperty("keystore.password")
    keystoreAlias = properties.getProperty("keystore.alias")
    keystoreAliasPWD = properties.getProperty("keystore.alias_password")
} else {
    keyFile = file("../no_exists_keystore.tmp")
}

def isRunningOnTravis = System.getenv("CI") == "true"
if (isRunningOnTravis) {
    keyFile = file("../mrd@vdreamers")
    keystorePWD = System.getenv("KEYSTORE_PWD")
    keystoreAlias = System.getenv("KEYSTORE_ALIAS")
    keystoreAliasPWD = System.getenv("KEYSTORE_ALIAS_PWD")
}

android {
    signingConfigs {
        release {
            keyAlias keystoreAlias
            keyPassword keystoreAliasPWD
            storeFile keyFile
            storePassword keystorePWD
        }
    }
    buildTypes {
        debug {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.debug
        }
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            if (keyFile.exists() || isRunningOnTravis) {
                println("WITH -> buildTypes -> release: using jks key")
                signingConfig signingConfigs.release
            } else {
                println("WITH -> buildTypes -> release: using default key")
                signingConfig signingConfigs.debug
            }
        }
    }
}

本地构建需要在本地 local.properties 中配置好证书路径 keystore.path、证书密码 keystore.password、证书别名 keystore.alias、证书别名密码 keystore.alias_password；
分别对应着 Travis CI 控制台加密的证书秘钥对和环境变量证书密码 KEYSTORE_PWD、证书别名 KEYSTORE_ALIAS、证书别名密码 KEYSTORE_ALIAS_PWD。

部署

GitHub Release

  1. 命令行自动生成 deploy 配置。
1
travis setup releases

需要输入 GitHub 账户名和密码以及 apk 路径，如 app/build/outputs/apk/app-release.apk
执行完后会自动在 .travis.yml 添加如下配置：

1
2
3
4
5
6
7
8
9
10
11
deploy:
  provider: releases
  api_key:
    secure: qOr4mGdf8lESDCiMo7ZJbGqLEHI3cXuV4UlQ2ZzvjSpDQyXrQ2l8wHMdgTkFxmlJWReOUuumHK346StBlGA2mQ5ufc6LhtHaCJWNpnk2Nixd2qFma9ySgPakz+7NoMml4wvkgMnn4HBCTV13ucJPxEzVt8KkX1JAiN9s5rh8SkB36i9KC4i/SuAPNPx2vHbglnoPFtToBlQa+cMLRSlXVkLHYYVdWRZOBRneu/H79oPkw5ajfsSG5u7RCCcEaaAfY1oU7ho1mrB1Kogq64BemGZSkIHgF5TCmmWgNypDlAm92tCN0G3uP0xffUZZsUqYoHiflXTjyXoYG4gXXC+SCCmkkFah0DZPcTZ6AHerBJ/8YgJX6/8tV3sH89PuM6HEuPmHbE3xEsGzUZWNrkJWHdJBLi5bXZnuSRvq+JDM/0CYSYuTx+lHCcCUiODIKTXFwHOaB+J+bKUTvvz91Rd7ELodUiBTAI/hXDYmWBAgY9Snw8+qBXiA7Ocp+ykcRuiUXXxvYlLgIzqtTEnoODBOsZ5ukjJoUs2GObcOgyBt4eedv7EfUcUKxHdf7ECZbhCEvhtVvHGzzIN5BN3R8+YJKnb0CmsO6FyCgCSnTyvKlFVfSX5s0v9E7XVFrCOo1gVDoL28v7AmrDZsl1mEaRSvVcOHtAXEhZEyF0CdafJ6s5A=
  file: app/build/outputs/apk/app-release.apk
  # 这句手动添加
  skip_cleanup: true
  on:
    repo: CodePoem/VTemplate
    # 这句手动添加
    tags: true
  • provider：发布目标为 GitHub Release ，除了 GitHub 外，Travis CI 还支持发布到 AWS 、Google App Engine 等数十种 provider 。
  • secure：是加密后的 GitHub Access Token 。
  • file：发布的文件。
  • skip_cleanup：默认情况下 Travis CI 在完成编译后会清除所有生成的文件，因此要将 skip_cleanup 设置为 true 来忽略此操作。
  • on：发布的时机，这里配置为 tags : true，即只在有 tag 的情况才发布。
  1. 打 Tag 后 Push 代码触发 CI 。
1
2
git tag -a v0.0.1-alpha-1 -m "这里是Tag注释，说清楚这个版本的主要改动，也可以省略-m参数直接写长文本"
git push origin --tags

Fir.im

  1. 登录 Fir.im 获取 API Token 。
  2. 将获取的 API Toke n 配置到 Travis CI 的环境变量 FIR_API_TOKEN。
  3. 添加配置。
1
2
3
4
before_install:
  - gem install fir-cli
after_deploy:
  - fir p app/build/outputs/apk/release/app-release.apk -T $FIR_API_TOKEN -c "`git cat-file tag $TRAVIS_TAG`"
  1. 打 Tag 后 Push 代码触发 CI 。

通知

SendCloud 邮件通知

  1. 注册 SendCloud 。
  2. 创建触发式模板 update_template 。
1
2
3
4
5
6
7
%TRAVIS_REPO_SLUG%新版本%TRAVIS_TAG%已经发布了，功能更新：


%TAG_DESCRIPTION%

去下载：
https://fir.im/ep8s
  1. 添加配置，调用发送邮件 API 。
1
2
3
after_deploy:
  - curl -d "apiUser=******&apiKey=******&from=test@test.com&fromName=testTitle&subject=测试&replyTo=test@test.com&templateInvokeName=update_template"
    --data-urlencode "xsmtpapi={'to':['806957428@qq.com'],'sub':{'%TRAVIS_REPO_SLUG%':['$TRAVIS_REPO_SLUG'],'%TRAVIS_TAG%':['$TRAVIS_TAG'],'%TAG_DESCRIPTION%':['$(git cat-file tag $TRAVIS_TAG)']}}" http://api.sendcloud.net/apiv2/mail/sendtemplate
  1. 打 Tag 后 Push 代码触发 CI 。