使用Gradle编写蒲公英自动上传安装包和更新说明脚本

Github: https://github.com/windinwork/PgyerGradleApplication

平时测试中发包的时候,笔者在打完包就直接拖到蒲公英上让它上传就完事了。不过前两天的会议上,测试小姐姐提出要在蒲公英上写明这次的测试包修改了什么内容。

笔者一想到上传完包还要一个个打字说明在这个包我修改了什么,立即强烈拒绝!但是测试小姐姐再三要求,碍于这确实是个好提议和会上坐着的老大,只好勉为其难地答应发包时写上改动内容T_T。但是懒惰如笔者,当然不会每次发包都手动打字啦,最好能打完包后自动把包和修改信息上传到蒲公英。

虽然嘴上说着不要不要,但笔者想到写个自动化脚本还是很兴奋的。本来想看看有没有现成的蒲公英自动上传脚本,在网上搜索了一下发现都不是很对胃口,想想还是自己写算了。所以今天花了半天写了这个脚本,在这里也分享一下相关的gradle配置,以供参考。

一、 自动上传蒲公英

向蒲公英这样的平台一般提供API用来做一些便利的操作,我们直接打开蒲公英文档,可以看到用于上传安装包的API和示例的上传方法,我们便采用其中的curl的方法上传安装包。

上传接口的参数中,有三个是必填的,分别的uKey_api_keyfileuKey_api_key我们在自己的蒲公英帐号上可以查看到,而file参数需要我们提供apk文件的路径,所以我们先想办法拿到路径。

这里我们定义一个方法:getApkPath(),通过buildDir + 固定的outputs/apk/${buildType}/app-${buildType}.apk地址来获取apk路径。

1
2
3
4
def getApkPath() {
String buildType = getBuildType().toLowerCase()
return new File(buildDir, "outputs/apk/${buildType}/app-${buildType}.apk").absolutePath
}

getApkPath()中我们需要知道编译打包和用的buildType,这里定义一个方法getBuildType()进行获取。本人对gradle脚本不太熟悉,暂时通过打包参数来获取相应的buildType,足以应付一般场景。

1
2
3
4
5
6
7
8
9
10
def getBuildType() {
Gradle gradle = getGradle()
String args = gradle.getStartParameter().getTaskRequests().toString()
if (args.contains("assembleRelease")) {
return "Release"
} else if (args.contains("assembleDebug")) {
return "Debug"
}
return "Debug"
}

然后我们把上传命令封装在一个task里:

1
2
3
4
5
6
7
8
9
10
11
task pgyer(type: Exec) {

String apiKey = "6767f341ee7ed1f9fd4699e6ed71e773" // todo 这里替换为自己的蒲公英的apiKey
String userKey = "0cf7164e5158effc01cc24c0667266c4" // todo 这里替换为自己的蒲公英的userKey

commandLine 'curl'
args '-k', 'http://www.pgyer.com/apiv1/app/upload',
'-F', "uKey=${userKey}",
'-F', "_api_key=${apiKey}",
'-F', "file=@${getApkPath()}"
}

这样我们就在一个task可以调用啦。进入Terminalgradlew clean assembleDebug pgyergradle脚本便会执行清理、编译打包、上传的工作。等命令执行完,我们便能在蒲公英上看到新鲜出炉的安装包了。

二、自动添加日志

笔者目前想到自动从git记录中读取近期的log,进行一定格式化后上传到蒲公英。

首先我们来读取git的记录:

1
2
3
def getGitLog() {
return 'git log --pretty=format:"%s___in___%ad___by___%an" -10 --date=format:%c'.execute().text
}

其中%s__in__%ad__by__%an表示内容+日期+作者,-10表示显示最近10条log,--date=format:%c表示输出本地的日期时间。这里发现执行命令时如有空格不能输出git log,所以使用___来代替空格。

有时我们会想添加自定义的信息进去,所以需要一个参数用于传递自定义的信息,这里将参数定义为pgyerDesc,然后在gradle中获取pgyerDesc

1
2
3
if (project.hasProperty("pgyerDesc")) {
desc = pgyerDesc + "\n" + desc
}

对于传入的参数pgyerDesc,在Windows中,输入中文会出现乱码,应该是编码格式的问题。笔者用的是Ubuntu系统,所以不会有这个问题的出现。所以这个乱码的情况就交给Windows的同学自己去解决啦。

好了,整合起来,蒲公英自动上传安装包和日志的gradle脚本就实现了。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
task pgyer(type: Exec) {

String apiKey = "6767f341ee7ed1f9fd4699e6ed71e773" // todo 这里替换为自己的蒲公英的apiKey
String userKey = "0cf7164e5158effc01cc24c0667266c4" // todo 这里替换为自己的蒲公英的userKey
String desc = getGitLog()

if (project.hasProperty("pgyerDesc")) {
desc = pgyerDesc + "\n" + desc
}
if (desc == null || desc.isEmpty()) {
desc = "保持沉默"
}

commandLine 'curl'
args '-k', 'http://www.pgyer.com/apiv1/app/upload',
'-F', "uKey=${userKey}",
'-F', "_api_key=${apiKey}",
'-F', "file=@${getApkPath()}",
'-F', "updateDescription=${desc}"
}

三、总结

最后,为了保持功能模块分工清晰和代码复用,我们把新建一个pgyer.gradle的文件,将这个task单独存放起来。再在appbuild.gradle中通过apply from的方式引入pgyer.gradle。我们运行gradlew assembleDebug pgyer -P pgyerDesc="请多多关注",就可以看到想要的效果了。

该脚本是在gradle4.4的环境下进行,这里也做了一个Demo放在Github上了,里面的一些参数设置可能根据小伙伴自己的需求再做调整。希望各位能够喜欢这篇蒲公英自动上传脚本的文章。

推荐文章