uploadConfigurationName タスクについて

uploadConfigurationName タスクは、Gradle の標準プラグインのひとつである baseプラグインで提供されるものです。Android Gradleプラグインを使用する場合は、自動的にこのプラグインが適用されるようです*1。

• 標準プラグイン:Chapter 22. Standard Gradle plugins

uploadConfigurationName タスクは、その名のとおり、ConfigurationName のコンフィギュレーションに属する artifact をビルドし、ビルド結果をアップロードするタスクです。 例えばarchivesコンフィギュレーションに属する artifact をビルドしてアップロードするために、uploadArchives というタスクを使用できます。

archivesコンフィギュレーションについて

依存ライブラリなどを管理するためのコンフィギュレーションの仕組みが Gradle にはあるわけですが、アップロードする artifact の管理にもコンフィギュレーションが使用されます。Javaプラグインによってプロジェクトで生成される JAR が含まれるデフォルトのコンフィギュレーションがarchives です。 同様に、Android Gradleプラグインで生成される AAR パッケージも、デフォルトでarchivesコンフィギュレーションに含まれます。

自分でコンフィギュレーションを定義して、そこに AAR パッケージを含めるようにしてもいいのですが、特にそうする理由がなければ、このarchivesコンフィギュレーションをそのまま使えばいいでしょう。

Javadoc の JAR と sources の JAR を作成するタスクを定義し、それらの JAR をarchives configuration に追加する

Maven Central に公開する場合は、Javadoc を固めた JAR とソースコードを固めた JAR もアップロードする必要があります。 そのため、この 2 つの JAR を生成するタスクを定義し、それらの JAR をarchivesコンフィギュレーションに含めるようにする必要があります。

release variant でJavadoc JAR と sources JAR を作ればいいと思いますので、私は次のようにタスクを定義しました。

android.libraryVariants.all { variant->if (variant.name =='release') {def javadocTaskName ="javadoc${variant.name.capitalize()}";        task(javadocTaskName, type: Javadoc) {            description"Generates Javadoc for${variant.name}."            source = variant.javaCompile.source            destinationDir = reporting.file("${variant.name}-docs")            ext.androidJar ="${android.plugin.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"            classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)        }        task("javadocsJar${variant.name.capitalize()}", type: Jar) {            classifier ="javadoc"            from tasks[javadocTaskName].destinationDir        }        task("sourcesJar${variant.name.capitalize()}", type: Jar) {            classifier ="sources"            from variant.javaCompile.source        }/* artifacts management.         * See: http://www.gradle.org/docs/current/userguide/artifact_management.html */        artifacts {            archives tasks["javadocsJar${variant.name.capitalize()}"]            archives tasks["sourcesJar${variant.name.capitalize()}"]        }    }}

もうちょっときれいに書ければ嬉しいのですが、なかなか難しそうです。

• 参考:Generate JavaDocs with Android Gradle plugin - Stack Overflow

これ以降は AAR でも JAR でも大差ないのですが、一通り説明しておきます。

Maven の POM 情報を記述する

Mavenプラグインを使って、uploadArchives の設定として POM の情報を記述します。

• Chapter 52. The Maven Plugin

ここで記述されたプロジェクト名などを元に POM が生成されます。 以下のような感じになります。

apply plugin:'maven'version ="1.0-SNAPSHOT"// Maven のバージョン規約で、開発中のものには “-SNAPSHOT” を付けるext.isReleaseVersion = !version.endsWith("SNAPSHOT")group ="org.example.android.sugoi.project"uploadArchives {    repositories.mavenDeployer {// 後からここに署名のための記述やリポジトリの URL の記述などを行う        pom.artifactId ='sugoi-library'        pom.project {            name'Sugoi library'            packaging'aar'            description'This is Sugoi library'            url'http://sugoi.android.example.org/'            scm {                url'scm:git@github.com:yourname/sugoi-library.git'                connection'scm:git@github.com:yourname/sugoi-library.git'                developerConnection'scm:git@github.com:yourname/sugoi-library.git'            }            licenses {                license {                    name'The Apache License, Version 2.0'                    url'http://www.apache.org/licenses/LICENSE-2.0.txt'                    distribution'repo'                }            }            developers {                developer {                    id'yourname'                    name'Your Name'                    email'yourname@example.org'                }            }        }    }}

署名やアップロード先の記述

あとは、signingプラグインを使って署名するようにする設定と、アップロード先のMaven Repository の設定を書けば完了です。

• signingプラグイン:Chapter 53. The Signing Plugin

次のような記述になります。

apply plugin:'maven'apply plugin:'signing'signing {    required { isReleaseVersion && gradle.taskGraph.hasTask("uploadArchives") }    sign configurations.archives}uploadArchives {    repositories.mavenDeployer {        beforeDeployment { MavenDeployment deployment-> signing.signPom(deployment) }def sonatypeRepo = isReleaseVersion ?"https://oss.sonatype.org/service/local/staging/deploy/maven2/" :"https://oss.sonatype.org/content/repositories/snapshots/"        repository(url: sonatypeRepo) {            authentication(userName: sonatypeUsername, password: sonatypePassword)        }// ...}

signingプラグインで署名するためには、次のように Gradle プロパティを設定しておく必要があります。 ここで指定する keyId などは、「GPG クライアントをインストールし、GPG キーを作成して公開鍵を配布する」 の箇所で生成した鍵のものです。

signing.keyId=24875D73signing.password=secretsigning.secretKeyRingFile=/Users/me/.gnupg/secring.gpg

また、sonatypeRepo にアクセスするためのユーザー名とパスワードを、次のように Gradle プロパティで設定する必要があります。

sonatypeUsername=your_usernamesonatypePassword=your_password

Gradle プロパティは、プロジェクトや Gradle のホームディレクトリ (デフォルトでは USER_HOME/.gradle) に gradle.properties というファイルを作ってそこに記述することができますし、Gradle コマンドの -P オプションで指定することもできます*2。

• Gradle プロパティについて:Chapter 14. Tutorial - 'This and That'