ErQi

上传library到公共的jcenter仓库

发表于 | 分类于

一步一步的配置gradle来自动上传到Jcenter库

账户配置

首选需要拥有一个bintray的账号,还有与之对应的API key 可以直接使用github账号登陆.
登陆完成之后编辑页面下方列表中找到API key点击,得到自己的API key,保存下来就可以继续下一步.

在引用项目的时候,通常都是如下结构compile 'com.android.support:appcompat-v7:23.2.0'
结构分为三块,中间用:来进行隔开,示例:group:name:version

项目根部路配置

回到项目中来,首先需要在根目录的build.gradle加入如下配置.

1
2
3
4
5
6
7
8
ext {
    groupName = '对应group'
    artifactName = '对应name'
    artifactDescription = '项目的详细描述'
    artifactLabels = ['该项目的描述标签','可以多个']
    releaseVersionCode = 1 			// 当前的版本
    releaseVersionName = '1.0.0'	// 当前的版本名称
}

最后在加入两个帮助发布项目的插件,加载哪就不多说了,详细信息可以看项目github,maven 1.3插件需要gradle 2.4+支持,需要注意

1
2
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'

上传的Module配置

然后去到需要上传的module中,开始在该module的build.gradle进行配置

  1. 添加插件

    1
    2
    3
    // 在根节点上添加
    apply plugin: 'com.github.dcendents.android-maven'
    apply plugin: 'com.jfrog.bintray'

  2. 定义相关网站

    1
    2
    3
    // 这里就是直接引用根目录下的相关配置
    def siteUrl = "https://github.com/ErQi/${rootProject.ext.artifactName}"
    def gitUrl = "https://github.com/ErQi/${rootProject.ext.artifactName}.git"

  3. 定义pom并打包aar

    上传到jcenter至少需要四个文件，除了打包的aar之外，还需要pom和javadoc，source，否则是通不过jcenter审核的。不过不用紧张，这些我们都可以用脚本生成。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    // 根节点添加
    install {
        repositories.mavenInstaller {
            // This generates POM.xml with proper parameters
            pom {
                project {
                    packaging 'aar'
                    // Add your description here
                    name rootProject.ext.artifactName
                    url siteUrl
                    // Set your license
                    licenses { 
                        license {
                            name 'The MIT License (MIT)'
                            url 'http://opensource.org/licenses/MIT'
                        }
                    }
                    developers {
                        developer {
                            id 'ErQi'
                            name 'ErQi'
                            email 'shengguangchanhui@foxmail.com'
                        }
                    }
                    scm {
                        connection gitUrl
                        developerConnection gitUrl
                        url siteUrl
                    }
                }
            }
        }
    }

  4. 打包javadocjar和sourcejar

    这是上传到jcenter必须的. 

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    // 根节点下
    task sourcesJar(type: Jar) {
        from android.sourceSets.main.java.srcDirs
        classifier = 'sources'
    }
    task javadoc(type: Javadoc) {
        source = android.sourceSets.main.java.srcDirs
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
        options.encoding = 'UTF-8'
    }
    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from javadoc.destinationDir
    }
    artifacts {
        archives javadocJar
        archives sourcesJar
    }

  5. 配置Jcenter相关信息

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    Properties properties = new Properties()
    File propertyFile = project.rootProject.file('local.properties') // 这里将Jcenter的用户信息保存在local.properties文件中
    properties.load(propertyFile.newDataInputStream())
    bintray {
        user = properties.getProperty("bintray.user") //你的Jcenter账户
        key = properties.getProperty("bintray.apikey") //你的Jcenter账户的API key
        configurations = ['archives'] //When uploading Maven-based publication files
        dryRun = false //Whether to run this as dry-run, without deploying
        publish = true //If version should be auto published after an upload
        pkg {
            repo= 'maven' //发布到那个仓库
            name = rootProject.ext.artifactName // 库的名称
            desc = rootProject.ext.artifactDescription // 描述
            websiteUrl = siteUrl // 项目网址, 通常指向github链接 
            issueTrackerUrl = siteUrl + '/issues' // 同上
            vcsUrl = gitUrl	// 同上
            licenses = ['MIT']
            labels = rootProject.ext.artifactLabels 
            publicDownloadNumbers = true
            //Optional version descriptor
            version {
                name = rootProject.ext.releaseVersionName //Bintray logical version name
                released = new SimpleDateFormat('yyyy-MM-dd\'T\'HH:mm:ss.SSSZZ').format(new Date())
                //2 possible values: date in the format of 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ' OR a java.util.Date instance
                vcsTag = rootProject.ext.releaseVersionName
            }
        }
    }

  6. 运行上传指令

    当以上配置完成时,就可以运行gradle指令了
    当两个任务都OK时,就可以登录自己的账户去提交审核了
    在bintray的个人主页可以在右下角看到最近提交的记录,点击项目名称,即可进入到项目界面.
    然后在主页的右下方找到Add to JCenter,然后在暂开网页中随便填一点描述信息,即可提交审核,当审核完成就可以使用了简单的一行直接导入了.

    1
    2
    gradle install
    gradle bintrayUpload

  7. 可能出现的坑

    第一个指令用于生成pom.jar包,生成时会检测对应的方法注释,请确保注释完成无误.
    第二个指令用于上传到指定的Jcenter账户,请确认账户的信息是否输入完成,例如该项目的user,apikey,可将此信息放置于其他文件中,此处保存在了local.properties文件中,上传时若出现user apikey等错误信息,请确认账户信息是否有误.

    1
    2
    3
    4
    5
    6
    Properties properties = new Properties()
    File propertyFile = project.rootProject.file('local.properties') // 这里将Jcenter的用户信息保存在local.properties文件中
    properties.load(propertyFile.newDataInputStream())
    bintray {
        user = properties.getProperty("bintray.user") //你的Jcenter账户
        key = properties.getProperty("bintray.apikey") //你的Jcenter账户的API key