Gradle 上传aar到私有moven库，并附带git相关信息

前言

将一些共用的组件打包成aar，上传到公司内部的私有moven库，供给公司不同的团队使用，这样可以使团队专注于自己的事情，多条业务线并行开发。

我们使用的是nexus搭建内部私有moven库http://www.sonatype.org/nexus/go

在实际的使用过程中，碰到过两个问题。

如何追溯当前上传的aar对应哪次提交的代码，比如上传了一个aar文件，如何知道它对应上传时的git commit id
有时开发人员上传aar时，代码还没有提交，这样就无法追溯上传的aar的相关git记录。

具体优化

针对以上2个问题，优化了下gradle Android项目aar的上传moven库脚本。（此脚本是单独的gradle文件，使用的化只需要在模块的build.gradle里面引入这个文件就行）


apply plugin: 'maven'
//aar 版本号
def verName = "1.0.0"
//moven库 地址
def maven_path = 'http://10.88.1.1:8081/repository/maven-releases/'

def artifact_id = 'test_demo'
def group_id = 'com.mypackage.test'
//moven库 账号密码
def account = 'upload'
def password = '123456'

//git information
def authorName="unkown"
def commitId="unkown"
def commitMsg="unkown"
def date="unkown"

uploadArchives {
    repositories {
        mavenDeployer {
            //当前git的相关信息
            pom.withXml {
                def root = asNode()
                //添加git节点
                def depsNode = root.appendNode("Git")
                //最近一次提交的git作者
                depsNode.appendNode("author",authorName)
                //最近一次提交的commitid
                depsNode.appendNode("commitid",commitId)
                //最近一次提交的message
                depsNode.appendNode("commitMsg",commitMsg)
                //最近一次提交的时间
                depsNode.appendNode("time",date)
            }
            //aar 的相关信息
            pom.project {
                groupId group_id
                artifactId artifact_id
                version verName
                packaging 'aar'
            }
            repository(url: maven_path) {
                //moven账户相关信息
                authentication(
                        userName: account,
                        password: password
                )
            }
        }
    }
}

/**
 * gradle 运行git show命令
 * 从结果提取git的相关信息
 */
task gitLog{
    doLast {
        println 'git log'
        def cmd1 = 'git show'
        def gitResult1=  cmd1.execute().text.trim()
        def results=gitResult1.split("\n")
        def commitIdString=results[0]
        def AuthorString=results[1]
        def DateString=results[2]
        def CommitMessageString=results[4]
        commitId=commitIdString.substring(7,commitIdString.size()-1)
        authorName=AuthorString.substring(8,AuthorString.size()-1)
        date=DateString.substring(6,DateString.size()-1)
        commitMsg=CommitMessageString
//        for (resultTemp in results){
//            println("resultTemp="+resultTemp)
//        }
    }
}
/**
 * 判断是否有未提交的代码
 * 运行命令'git status -suno'
 * 如果有输出 代表有未提交代码 此时直接抛出gradle异常
 * 如果输出为空代表没有未提交代码
 */
task gitCheckUncommit{
    doLast {
        def cmd1 = 'git status -suno'
        def gitResult1=  cmd1.execute().text.trim()
        if(gitResult1){
            println 'has uncommit message'
            throw new GradleException("请先提交代码再上传aar")
        }else {
            println 'do not have uncommitted message'
        }
//        for (resultTemp in results){
//            println("resultTemp="+resultTemp)
//        }
    }
}

//uploadArchives 依赖于task assemble 先需要生成aar 才能上传
uploadArchives.dependsOn(assemble)
//uploadArchives 依赖于task gitlog 先获取git的相关记录
uploadArchives.dependsOn(gitLog)
//uploadArchives 依赖于task gitCheckUncommit 先判断git是否有未提交的文件
uploadArchives.dependsOn(gitCheckUncommit)

这个脚本定义了3个task,其中:
uploadArchives是上传aar的脚本。
gitLog是运行git命令git show并从结果中提取相关信息。
gitCheckUncommit是判断当前否有未提交的代码，如果有代码之前抛出异常。

taskuploadArchives依赖于gitLog和gitCheckUncommit，这样就先去取git的相关信息，再去判断当前有没有未提交的文件，最后再去执行上传aar任务。

脚本使用和效果图

运行脚本有2种方式

双击Android studio gradle 选项卡中任务uploadArchives

upload.png
在命令行运行./gradlew :ModuleName:uploadArchives(我是linux系统，window直接gradlew :ModuleName:uploadArchives就好)

上传之后我们可以查看aar下的pom文件

pom.png

我们可以看到记录了相关的git信息

aar_info__01.png

最后编辑于：2021.03.09 08:46:06