Android通過Gradle釋出開源專案到binary/Jcenter

SunnySky發表於2017-09-29
AndroidGradle
一、儲存bintary賬號資訊

首先，我們需要一個bintray帳號，通過bintray.com進行註冊。

在登陸後，點選edit開啟編輯，然後點選api key

注意每個人的api key都是不一樣的，這裡需要對它進行保密，不要告訴別人，否則別人可以通過你的api key對提交的庫進行調整。得到API key之後就需要在我們的專案中對它進行設定儲存了。

此處有兩種方式進行配置，值分別是你在bintray上的api key和你的user name。

  1. 到你的.gradle目錄下（如果你沒有配置過GRADLE_USER_HOME的環境變數，則是在你的使用者目錄下），編輯gradle.properties（如果沒有則建立），加入配置：
    BINTRAY_USER=xxx  
BINTRAY_KEY=xxx複製程式碼
  2. 找到專案本地的local.properties（如果沒有就新建它），這是本地的配置檔案，一般我們提交到github的時候，這個檔案都會被ignore，所以我們不用擔心資訊被別人看到。然後同樣加上如上配置。
二、編輯Gradle檔案

在最外面的那個build.gradle檔案中入如下配置

classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'

 // Remove it if you won't to publish SNAPSHOT version.
classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.0.0"複製程式碼

最新版本資訊可以在以下連結檢視。

github.com/bintray/gra…

github.com/dcendents/a…

在library中新增binary.gradle檔案，加入如下程式碼

group = PROJ_GROUP
version = PROJ_VERSION
project.archivesBaseName = PROJ_ARTIFACTID

apply plugin: 'com.jfrog.bintray'
apply plugin: 'com.github.dcendents.android-maven'

task sourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier = 'sources'
}

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    classpath += configurations.compile
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

javadoc {
    options{
        encoding "UTF-8"
        charSet 'UTF-8'
        author true
        version true
        links "https://androiddoc.qiniudn.com/reference/"
        title "$PROJ_NAME $PROJ_VERSION"
    }
}

artifacts {
    archives sourcesJar
    archives javadocJar
}

install {
    repositories.mavenInstaller {
        pom.project {
            name PROJ_NAME
            description PROJ_DESCRIPTION
            url PROJ_WEBSITEURL
            inceptionYear '2016'

            packaging 'aar'
            groupId PROJ_GROUP
            artifactId PROJ_ARTIFACTID
            version PROJ_VERSION

            licenses {
                license {
                    name 'The Apache Software License, Version 2.0'
                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                    distribution 'repo'
                }
            }
            scm {
                connection PROJ_VCSURL
                url PROJ_WEBSITEURL

            }
            developers {
                developer {
                    id DEVELOPER_ID
                    name DEVELOPER_NAME
                    email DEVELOPER_EMAIL
                }
            }
        }
    }
}

bintray {
    user = project.hasProperty('bintrayUser') ? project.property('bintrayUser') : project.property('BINTRAY_USER')
    key = project.hasProperty('bintrayKey') ? project.property('bintrayKey') : project.property('BINTRAY_KEY')

    configurations = ['archives']

    dryRun = false
    publish = true

    pkg {
        repo = 'maven'   //倉庫名
        name = PROJ_NAME
        licenses = ['Apache-2.0']
        vcsUrl = PROJ_VCSURL
        websiteUrl = PROJ_WEBSITEURL
        issueTrackerUrl = PROJ_ISSUETRACKERURL
        publicDownloadNumbers = true
        version {
            name = PROJ_VERSION
            desc = PROJ_DESCRIPTION
            vcsTag = PROJ_VERSION

            gpg {
                sign = true
            }
        }
    }
}

//以下內容用於釋出SNAPSHOT版本，如果不需要可以移除。
//參考自：https://www.jfrog.com/confluence/display/RTF/Gradle+Artifactory+Plugin

apply plugin: "com.jfrog.artifactory"
artifactory {
    contextUrl = 'http://oss.jfrog.org/artifactory' //The base Artifactory URL if not overridden by the publisher/resolver
    resolve {
        repository {
            repoKey = 'libs-release'
        }
    }
    publish {
        repository {
            repoKey = 'oss-snapshot-local' //The Artifactory repository key to publish to
            username = bintray.user
            password = bintray.key
            maven = true
        }
        defaults {
            //這裡的名字和前面bintray.configurations的值一致即可，會將其包含的輸出上傳到jfrog上去
            publishConfigs('archives')
        }
    }
}複製程式碼

在library的bulid.gradle下新增

apply from: './bintray.gradle'複製程式碼
三、在gradle.properties 檔案新增如下配置
PROJ_GROUP=com.iceuncle（專案組名）
PROJ_VERSION=1.1.1（版本號）
PROJ_NAME=PasswordBox（專案名）
PROJ_WEBSITEURL=https://github.com/iceuncle/PasswordBox（專案地址）
PROJ_ISSUETRACKERURL=（不管它）
PROJ_VCSURL=https://github.com/iceuncle/PasswordBox.git（專案倉庫）
PROJ_DESCRIPTION=android passwordbox widget（專案描述）
PROJ_ARTIFACTID=passwordbox（專案標籤）

DEVELOPER_ID=xxxxxx
DEVELOPER_NAME=xxxxxx
DEVELOPER_EMAIL=tianyang.wu998@gmail.com複製程式碼

上面的例子最終在Android Studio中的引用形式為

dependencies {
    compile 'com.iceuncle:passwordbox:1.1.1'
}複製程式碼

可以發現，它的格式是 PROJ_GROUP:PROJ_ARTIFACTID:PROJ_VERSION組成。

四、執行命令釋出

執行./gradlew install
如果你成功了，則可以在module的build/outputs下面看到你的aar檔案
執行 ./gradlew bintrayUpload 將庫釋出到 bintray.com
執行 ./gradlew artifactoryPublish 可以釋出版本到 oss.jfrog.org

五、將庫加入Jcenter

最後一步，需要登入bintray.com，將我們剛剛釋出的庫申請加入到jcenter，這樣別人才能直接引用到。

進入bintray.com/bintray/jce…，點選Include My Package，然後在彈出的對話方塊中搜尋並勾上你的專案。然後你可以寫一下你的提交請求（貌似也可以不寫？），點“Send”，接下來就看管理員稽核了。

六、遇到的錯誤以及解決方案

1. HTTP/1.1 404 Not Found [message:Repo 'maven' was not found]

需要登入bintray並建立一個maven repo

  • 點選Add New Reposititory
  • 輸入name: xxx，type選擇maven，點選create
  • 將name更新至binary.gradle檔案中的repo

2. 提示HTTP/1.1 401 Unauthorized [message:This resource requires authentication]
使用者名稱或密碼肯定填錯了

3. java.net.SocketException: Operation timed out (Read failed)
需要先執行./gradlew install，然後再執行./gradlew bintrayUpload進行釋出。

七、程式碼參考

具體的程式碼參考我github上寫的一個簡單的專案：PasswordBox
覺得有用的話，請多多Star噢(￣▽￣)~*

相關文章