上一篇文章里使用Gitlab搭建Android和iOS的持续集成和持续发布环境(一),我们已经搭建好了Gitlab,现在我们要实现Android&iOS的持续发布和持续集成还需要用到Gitlab-CI.要使用Gitlab-CI最关键的是还需要安装一个gitlab-runner的组件。gitlab不会做测试和打包或者具体的事情,都是交给下面的gitlab-runner来执行。这个组件安装在你用来执行集成测试或者打包的服务器上,也可以装在你搭建gitlab的服务器上。
安装gitlab-ci-multi-runner
参考文档地址
这次我们把gitlab-runner安装在一台Mac机器上,因为我们后面是需要用这个gitlab-ci-runner打包iOS的App的,所以需要一台Mac电脑。其他系统的安装方式文档也写得很清楚了。
Mac系统的安装一条命令就搞定
sudo curl --output /usr/local/bin/gitlab-ci-multi-runner https://gitlab-ci-multi-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-ci-multi-runner-darwin-amd64
#给它可执行的权限
sudo chmod +x /usr/local/bin/gitlab-ci-multi-runner
安装好之后回到我们的gitlab。
创建项目
现在我们在gitlab上创建一个项目我这里取名字叫做Android_CiCd_Test
在第一次创建项目的时候会建议你添加ssh key,添加ssh key之后相当于一个登录的认证,以后推送代码的时候就不用输入密码了,怎么添加和生成ssh key可以参考这里。
现在我们新建一个Android项目并上传到gitlab上。
在项目的根目录下新建一个.gitlab-ci.yml文件,也可以在gitlab上点击
推荐在web端进行配置,因为web端有验证,可以验证你的脚步配置是否正确。下面是我的配置
stages:
- build_release
- build_dev
- cleanup
- test
cache:
paths:
- .gradle/wrapper
- .gradle/caches
test_job:
stage: test
#这个是每次提交或者合并代码都会执行测试和ui测试
script:
- gradle test
#进行ui测试需要连接模拟器,如果没有ui测试可用不要
- gradle connectAndroidTest
cleanup_build_job:
stage: cleanup
script:
- grale clean
#只在构建失败的时候执行clean
when: on_failure
build_release_job:
stage: build_release
script: "sh /your file path/build_release_package.sh"
#需要手动触发
when: manual
#只会在master分支上执行
only:
- master
#打包好的物料的地址 会自动上传到gitlab
artifacts:
paths:
- app/build/outputs/apk/*build*
build_debug_job:
stage: build_dev
script: "sh /your file path/build_develop_package.sh"
when: manual
artifacts:
paths:
- app/build/outputs/apk/*develop*
脚本放上去之后在pipeline界面就能看到你的任务了,但是现在还不能运行,还需要设置Gitlab-runner。如下图
点击进去之后会看到
How to setup a new project specific runner
Install GitLab Runner software. Checkout the GitLab Runner section to install it
Specify the following URL during runner setup:
http://xx.xx.xx.xx:8863/ci
Use the following registration token during setup:
6bChfsFFxxxxxxxxxxxx
Start runner!
相关信息:https://docs.gitlab.com/ce/ci/runners/README.html#registering-a-specific-runner
现在回到我们装有gitlab-runner的机器上,进入命令行进行配置
输入下面的命令:sudo gitlab-ci-multi-runner register
按照交互提示输入上面的url和token即可。
现在再回到gitlab上的pipeline中,已经可以运行了。
Android项目的配置和打包脚本
在Android的项目中我提取了部分配置,因为有些配置我想在打包的时候动态修改的,所以提取出来,单独放到了一个config.gradle中。动态修改是通过打包的命令 gradle build -P attribute1=xxx -P attribute2=xxxx
-P参数可以给项目添加一个属性,然后在build.gradle中
完整的项目可以在这里下载:下载地址
/buildscript/config.gradle
allprojects {
repositories {
jcenter()
}
}
ext {
//app info 这些配置可以在打包的时候动态修改
appName = project.hasProperty("app_appName") ?
project.getProperties().get("app_appName") : "AndroidCITest"
applicationId = project.hasProperty("app_applicationId") ?
project.getProperties().get("app_applicationId") : "com.example.dzq.androidcicdtest"
versionCode = project.hasProperty("app_versionCode") ?
project.getProperties().get("app_versionCode") : "1"
versionName = project.hasProperty("app_versionName") ?
project.getProperties().get("app_versionName") : "0.0.1"
/*
*工程配置项
*/
app_configs = [api_endpoint: "http://172.17.12.13:8480",
test_id : "123456"]
}
/build.gradle
//注意这一行把buildscript/config.gradle中的配置加入进来了
apply from: 'buildscript/config.gradle'
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.1.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
allprojects {
repositories {
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
/app/build.gradle这个文件里我把获取到的信息拼装成了一个json然后放到了assets/config.json文件中了。在App启动的时候会先读取这个文件取得配置
apply plugin: 'com.android.application'
//初始化配置信息 以后可以动态配置App信息,然后写入到assets/config.json中,在App初始化的时候去读取config.json的配置
def configsInit() {
def configs = rootProject.ext.app_configs
String s = "{";
configs.each { key, value ->
if (project.hasProperty("app_" + key)) {
s = s + '"' + key + '":"' + project.getProperties().get("app_" + key).toString() + '",'
} else {
s = s + '"' + key + '":"' + value + '",'
}
}
s = s.substring(0, s.length() - 1) + "}";
File file = new File(getProject().name + "/src/main/assets/config.json")
file.write(s)
}
android {
//引用buildscript中的配置
def conf = rootProject.extensions.getByName("ext")
compileSdkVersion 24
buildToolsVersion "24.0.2"
defaultConfig {
//从conf中获取applicationId
applicationId conf.getAt("applicationId")
minSdkVersion 14
targetSdkVersion 24
//从conf中获取versionCode
versionCode Integer.parseInt(conf.getAt("versionCode"))
//从conf中获取versionName
versionName conf.getAt("versionName")
}
//建议把签名信息的敏感信息放在环境变量中
signingConfigs {
release {
storeFile file("../yourkey.jks")
storePassword "yourpwd"
keyAlias "youralias"
keyPassword "yourpwd"
}
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
versionNameSuffix "_build_" + project.getProperties().get("suffix").toString()
signingConfig signingConfigs.release
}
debug {
debuggable true
versionNameSuffix "_build_develop_" + project.getProperties().get("suffix").toString()
}
}
lintOptions {
abortOnError false
}
//给打包出来的Apk修改一下名字
applicationVariants.all { variant ->
variant.outputs.each { output ->
//初始化配置信息
configsInit()
def file = output.outputFile
if (project.hasProperty('suffix')) {
if (file.name.contains("debug.apk")) {
output.outputFile = new File(file.parent,
file.name.replace("-debug.apk", "_develop_build_" +
project.getProperties().get("suffix").toString() +
".apk"))
} else if (file.name.contains("release.apk")) {
output.outputFile = new File(file.parent,
file.name.replace("-release.apk", "_build_" +
project.getProperties().get("suffix").toString() +
".apk"))
}
}
}
}
}
//依赖信息
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:24.2.0'
compile 'com.google.code.gson:gson:2.7'
}
最后在献上一个我的打包脚本build_develop_package.sh
#!/usr/bin/bash
set -o nounset
set -o errexit
nowdate=`date +%m%d%H%M`
#用当前时间作为版本的build号
echo $nowdate
gradle clean
gradle -P suffix=$nowdate assembleDebug
到这里就可以根据打包时间打出不同build号的包了。
下一步是要动态配置在打包的时候调整配置,打出不同配置的包。具体思路就是在打包的时候,把我们需要修改的配置项设置到linux的环境变量中,然后在打包脚本中获取环境变量,然后使用gradle build -p
传递到project的属性中,在build.gradle中利用一个循环,取出环境变量,打包到App中。
最终效果类似下面(下面用了另外一个持续发布的工具GOCD进行打包):
设置好参数之后点击trigger pipeline就可以执行打包发布。
获取环境变量的打包脚本
#!/bin/bash
set -o nounset
set -o errexit
nowdate=`date +%m%d%H%M`
echo "clean project"
/usr/local/bin/gradle clean
echo "start build"
#读取环境变量以app_开头的变量拼装成appParam
appParam=''
while IFS='=' read -r name value ; do
if [[ $name == *'app_'* ]]; then
appParam="${appParam} -P ${name}=${!name}"
fi
done < <(env)
echo $appParam
/usr/local/bin/gradle assembleRelease -P suffix=$nowdate $appParam
#获取打包成功后的apk名字
appname=` ls app/build/outputs/apk/*${nowdate}*`
echo $appname
#这里是使用360加固进行加固,具体使用说明可以参考360加固的文档
java -jar ~/programs/jiagu/jiagu.jar -jiagu $appname . -autosign
jiaguName=`ls *sign*`
#上传app到fir上具体信息可以参考fir的command line文档
/usr/local/bin/fir publish $jiaguName
这个脚本会获取环境变量中的配置,并且传到project中的属性中,project中的build.gradle会获取这个配置,并写入到assets/config.json中。这样App在初始化的时候再去assets/config.json获取配置即可。