Github: https://github.com/windinwork/PgyerGradleApplication
平時測試中發(fā)包的時候,筆者在打完包就直接拖到蒲公英上讓它上傳就完事了。不過前兩天的會議上,測試小姐姐提出要在蒲公英上寫明這次的測試包修改了什么內(nèi)容。
筆者一想到上傳完包還要一個個打字說明在這個包我修改了什么马昙,立即強(qiáng)烈拒絕!但是測試小姐姐再三要求颅悉,礙于這確實(shí)是個好提議和會上坐著的老大帆调,只好勉為其難地答應(yīng)發(fā)包時寫上改動內(nèi)容T_T奠骄。但是懶惰如筆者,當(dāng)然不會每次發(fā)包都手動打字啦番刊,最好能打完包后自動把包和修改信息上傳到蒲公英含鳞。
雖然嘴上說著不要不要,但筆者想到寫個自動化腳本還是很興奮的芹务。本來想看看有沒有現(xiàn)成的蒲公英自動上傳腳本蝉绷,在網(wǎng)上搜索了一下發(fā)現(xiàn)都不是很對胃口,想想還是自己寫算了枣抱。所以今天花了半天寫了這個腳本潜必,在這里也分享一下相關(guān)的gradle配置,以供參考沃但。
一磁滚、 自動上傳蒲公英
向蒲公英這樣的平臺一般提供API用來做一些便利的操作,我們直接打開蒲公英文檔宵晚,可以看到用于上傳安裝包的API和示例的上傳方法垂攘,我們便采用其中的curl
的方法上傳安裝包。
上傳接口的參數(shù)中淤刃,有三個是必填的晒他,分別的uKey
、_api_key
和file
逸贾。uKey
和_api_key
我們在自己的蒲公英帳號上可以查看到陨仅,而file
參數(shù)需要我們提供apk
文件的路徑,所以我們先想辦法拿到路徑铝侵。
這里我們定義一個方法:getApkPath()
灼伤,通過buildDir
+ 固定的outputs/apk/${buildType}/app-${buildType}.apk
地址來獲取apk
路徑。
def getApkPath() {
String buildType = getBuildType().toLowerCase()
return new File(buildDir, "outputs/apk/${buildType}/app-${buildType}.apk").absolutePath
}
在getApkPath()
中我們需要知道編譯打包和用的buildType
咪鲜,這里定義一個方法getBuildType()
進(jìn)行獲取狐赡。本人對gradle
腳本不太熟悉,暫時通過打包參數(shù)來獲取相應(yīng)的buildType
疟丙,足以應(yīng)付一般場景颖侄。
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
里:
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
可以調(diào)用啦。進(jìn)入Terminal
享郊,gradlew clean assembleDebug pgyer
览祖,gradle
腳本便會執(zhí)行清理、編譯打包炊琉、上傳的工作展蒂。等命令執(zhí)行完,我們便能在蒲公英上看到新鮮出爐的安裝包了。
二玄货、自動添加日志
筆者目前想到自動從git
記錄中讀取近期的log皇钞,進(jìn)行一定格式化后上傳到蒲公英。
首先我們來讀取git的記錄:
def getGitLog() {
return 'git log --pretty=format:"%s___in___%ad___by___%an" -10 --date=format:%c'.execute().text
}
其中%s__in__%ad__by__%an
表示內(nèi)容+日期+作者松捉,-10
表示顯示最近10條log夹界,--date=format:%c
表示輸出本地的日期時間。這里發(fā)現(xiàn)執(zhí)行命令時如有空格不能輸出git log
隘世,所以使用___
來代替空格可柿。
有時我們會想添加自定義的信息進(jìn)去,所以需要一個參數(shù)用于傳遞自定義的信息丙者,這里將參數(shù)定義為pgyerDesc
复斥,然后在gradle
中獲取pgyerDesc
:
if (project.hasProperty("pgyerDesc")) {
desc = pgyerDesc + "\n" + desc
}
對于傳入的參數(shù)pgyerDesc
,在Windows
中械媒,輸入中文會出現(xiàn)亂碼目锭,應(yīng)該是編碼格式的問題。筆者用的是Ubuntu
系統(tǒng)纷捞,所以不會有這個問題的出現(xiàn)痢虹。所以這個亂碼的情況就交給Windows
的同學(xué)自己去解決啦。
好了主儡,整合起來奖唯,蒲公英自動上傳安裝包和日志的gradle
腳本就實(shí)現(xiàn)了。
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}"
}
三糜值、總結(jié)
最后丰捷,為了保持功能模塊分工清晰和代碼復(fù)用,我們把新建一個pgyer.gradle
的文件寂汇,將這個task
單獨(dú)存放起來病往。再在app
的build.gradle
中通過apply from
的方式引入pgyer.gradle
。我們運(yùn)行gradlew assembleDebug pgyer -P pgyerDesc="請多多關(guān)注"
健无,就可以看到想要的效果了荣恐。
該腳本是在gradle4.4
的環(huán)境下進(jìn)行,這里也做了一個Demo
放在Github上了累贤,里面的一些參數(shù)設(shè)置可能根據(jù)小伙伴自己的需求再做調(diào)整。希望各位能夠喜歡這篇蒲公英自動上傳腳本的文章少漆。