基于Travis CI的Android项目自动构建流程 | 赛邮分享(构建项目代码流程配置)

免费Travis-CI：https://travis-ci.org

收费Travis-CI：https://travis-ci.com

Step1：使用GitHub账户授权登录Travis CI。

Step2：同步GitHub上的库，对指定的库启用Travis CI

配置.travis.yml

Travis要求项目的根目录下面，必须有一个 .travis.yml文件。
这是配置文件，指定了Travis的行为。
该文件必须保存在GitHub仓库里面，一旦代码仓库有新的Commit，Travis就会去找这个文件，执行里面的命令。

代码语言：javascript复制language: android jdk: oraclejdk8 # 开启基于容器的Travis CI任务，让编译效率更高 sudo: false android: components: # 构建项目所用的BuildTools版本 - build-tools-28.0.3 # 用来编译项目的SDK版本 - android-28 # 添加Android Support Repository组件 - extra-android-m2repository # 添加Support Library组件 - extra-android-support before_script: - chmod +x gradlew script: # 生成release apk包 - ./gradlew assembleRelease

Travis生命周期：

Android项目发布需要证书文件和密码，将原始正常和密码放入到代码库是很不安全的。
Travis CI为此提供了两种解决方案：

因为Travis CI控制台无法上传文件，因此涉及到文件加密的部分，选择第一种方案。

Step1：本地安装Travis CLI命令行工具

代码语言：javascript复制gem install travis

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

代码语言：javascript复制travis login --org

Step3：进入项目根目录，加密证书

代码语言：javascript复制travis encrypt-file xch_android.jks --add

命令执行结果：

1. 在Travis CI控制台自动生成一对秘钥，形如： encrypted_d71df9144721_iv、 encrypted_d71df9144721_key

2. 基于秘钥通过 openssl对文件进行加密，并在根目录生成 xch_android.jks.enc文件

3. 在 .travis.yml中自动生成Travis CI环境下解密文件的配置。

Step1. 在Travis CI控制台配置 KEYSTORE_PASS、 ALIAS_NAME、 ALIAS_PASS三个环境变量。

Step2. 在项目的根目录下创建一个名为 keystore.properties文件（用于本地命令打包），并包含以下信息：

代码语言：javascript复制KEYSTORE_PASS=myStorePassword ALIAS_NAME=myKeyAlias ALIAS_PASS=myKeyPassword

Step3. 在 app module 的 build.gradle配置签名信息， System.getenv()用来获取Travis CI控制台配置的变量。

代码语言：javascript复制apply plugin: 'com.android.application' // 加载本地keystore.properties中的签名配置 def keyPropertiesFile = rootProject.file("keystore.properties") def keyProperties = new Properties() if (keyPropertiesFile.exists()) { keyProperties.load(new FileInputStream(keyPropertiesFile)) } android { compileSdkVersion 28 defaultConfig { applicationId "com.github.xch168.androidtravisci" minSdkVersion 16 targetSdkVersion 28 versionCode 1 versionName "1.0" testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" } signingConfigs { release { storeFile file("../xch_android.jks") storePassword keyProperties.containsKey("KEYSTORE_PASS") ? keyProperties['KEYSTORE_PASS'] : System.getenv("KEYSTORE_PASS") keyAlias keyProperties.containsKey("ALIAS_NAME") ? keyProperties['ALIAS_NAME'] : System.getenv("ALIAS_NAME") keyPassword keyProperties.containsKey("ALIAS_PASS") ? keyProperties['ALIAS_PASS'] : System.getenv("ALIAS_PASS") } } buildTypes { release { minifyEnabled false signingConfig signingConfigs.release proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } }

Travis CI在每次构建完成后，就会删除所有文件，设置缓存机制，可以保证规定的缓存文件不需要每次下载，提高每次构建的速度；但是如果在更好的基础配置的情况（比如更新Gradle版本等，建议先清除缓存在跑CI）。

在 .travis.yml文件添加如下配置：

代码语言：javascript复制before_cache: - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock - rm -fr $HOME/.gradle/caches//plugin-resolution/ cache: #指定缓存目录 directories: - $HOME/.gradle/caches/ - $HOME/.gradle/wrapper/ - $HOME/.android/build-cache

可以在后台手动删除Travis CI Cache：

Travis CI自动发布apk到GitHub Release

Step1. 执行travis命令自动生成deploy配置

代码语言：javascript复制travis setup releases

命令执行完后会自动在 .travis.yml添加如下配置：

代码语言：javascript复制deploy: provider: releases api_key: secure: b7dhz7j5tY73qbQo2GNccev7NgI6BNWNeEpEfmLTxRZ7DJptxtQuJIHF026zhHtXfRom/pSXw7qlRJXamPWl7Bc1i1lUNKX7Mdt3Fo7Z70ZAyT/6vak3EGlKqDU7Ta96MOB2+5+2nQ7nlTX4kkkeObSTbD6py4eUzktoxsPSwtjiWrq7KM4KgcJTAEGnZx4LJdFm6pgE3drkbN83J0ZP3fT7sf+5Ggv4WLa8y3l/gM3rQ0tARebDo4OuigJOmknOfcxkiAlTtVt1qw1STMaW4H/M47K1mSvQK9DxSHUCD7ngvxEJlUMtqvYSIqQItyT7D8SvDxUqpZZM6y6qAcp+q5qrnA/uC7Qa3kju3skH1XBXyA20TN/pLYKk1yuH7TLg9W+512Pmgtpr4AiZayChnNn4morhhhncsdnQf1T6ziWUNGHmMK8QcUzjBdZHOVsNHGUuaGk4hOPeTRi7ozHYMnNF1E8HJEhtLf7/BHH4o17x5wI2QuSmgwqlCbhAYEwL8m9ZtyJ7saqimGo6m37XfBlomBgaTMrCDIybqOABjPxASlMVRh84XZeeAHHLgjSRMoP2cb+lksiyhO2TsCOvQEOmofFcjj4+iN+qIynPMb3bonuce/iD9nNC2cusibYaIrr1+r2VWE61EdIiLlamw99fFT1VZtliJuJe9tugMgA= file: app/build/outputs/apk/app-release.apk # 这句手动添加 skip_cleanup: true on: repo: xch168/AndroidTravisCI # 这句手动添加 tags: true

说明：

Step2: 打 tag

代码语言：javascript复制git tag -a v0.0.1-alpha.1 -m "这里是Tag注释，说清楚这个版本的主要改动，也可以省略-m参数直接写长文本" git push origin --tags

Step3: 自动化构建、部署

蒲公英是APP内测分发平台，提供免费的APP内测分发托管，不但允许游客下载，还提供了二维码，下载速度快。

Step1. 使用GitHub授权登录https://www.pgyer.com/user/login

Step2. 获取API Key

Step3. 将获取的API Key配置到Travis CI的环境变量 PGYER_API_KEY：

Step4. 在 .travis.yml文件中，添加如下配置：

代码语言：javascript复制# 添加蒲公英上传脚本 before_install: - cd $TRAVIS_BUILD_DIR - wget -c https://raw.githubusercontent.com/Pgyer/TravisFile/master/pgyer_upload.sh -O pgyer_upload.sh - chmod +x pgyer_upload.sh # 在apk上传到GitHub后，使用蒲公英的上传脚本将apk上传到蒲公英 after_deploy: - set -e - $TRAVIS_BUILD_DIR/pgyer_upload.sh "${TRAVIS_BUILD_DIR}/app/build/outputs/apk/release/app-release.apk" $PGYER_API_KEY

Step5. 打完tag，Travis CI自动构建后，将在蒲公英的控制台看到上传的apk

上传apk到http://fir.im

http://fir.im和蒲公英的一样，都是免费的应用内测分发平台。

Step1. 登录https://fir.im/

Step2. 获取API Token。

Step3. 将获取的API Token配置到Travis CI的环境变量 FIR_API_TOKEN。

Step4. 在 .travis.yml文件中，添加如下配置：

代码语言：javascript复制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`"

Step5. 打完tag，Travis CI自动构建后，将在http://fir.im的控制台看到上传的apk

发送完毕后自动发送邮件通知

虽然Travis CI也有邮件通知功能，但是不能定制模板，通知内容仅仅为提示CI运行的结果，显然更适合开发人员。
我们希望最终能以更友好的方式通知团队成员，同时考虑到邮件送达率，可优先选择 Submail、SendCloud等国内邮件发送服务。

这里以Submail为例：

Step1. 注册登录Submail

Step2. 添加发信域名（这需要有自己的域名）

Step3. 创建APPID，并将APPKEY配置到Travis CI控制台的环境变量 SUBMAIL_SIGN。

Step4. 创建一封触发式邮件模板

代码语言：javascript复制@var(TRAVIS_REPO_SLUG)新版本@var(TRAVIS_TAG)已经发布了，功能更新： @var(TAG_DESCRIPTION) 去下载： https://fir.im/gkq1

Step5. 配置 .travis.yml

代码语言：javascript复制- curl -d "appid=14017&to=xucanhui168@gmail.com&subject=[自动通知] 安卓新版本$TRAVIS_TAG发布&project=Cpyvk2&signature=$SUBMAIL_SIGN&vars={\"TRAVIS_REPO_SLUG\":\"$TRAVIS_REPO_SLUG\",\"TRAVIS_TAG\":\"$TRAVIS_TAG\",\"TAG_DESCRIPTION\":\"$(git cat-file tag $TRAVIS_TAG | awk 1 ORS='<br>')\"}" https://api.submail.cn/mail/xsend.json

Step5. 运行结果

本文Demo：https://github.com/xch168/AndroidTravisCI