Публикация Android-библиотеки в репозиторий Maven с помощью Gradle

Разрабатывая библиотеку, рано или поздно приходит момент, когда нужно поделиться ею с другими. Нет, я сейчас говорю не про выкладывание исходников на GitHub, а про публикацию библиотеки в репозиторий Maven Central. Тем более, что выкладывать исходники там не обязательно, допускаются и проекты с закрытым исходным кодом.
Процесс публикации не слишком простой, поэтому без мануала не обойтись. Есть статья на Хабре, но в ней описана публикация Java-библиотеки при помощи Maven, а в моём случае библиотека для Android и используется Gradle, так что процесс значительно отличается.

Шаг 1. Регистрация в SonaType
1.1. Заходим на http://issues.sonatype.org/ и регистрируемся, нажав Sign Up.


Имя и фамилию следует указывать на английском, отчество не надо.

1.2. После этого заходим сюда https://issues.sonatype.org/browse/OSSRH и создаём тикет, нажав кнопку Create.


Не расписывайте слишком сильно свой проект, краткого описания из одного предложения будет достаточно.
Важным пунктом является groupId, на нём я остановлюсь подробнее.

groupId используется для идентификации разработчика, подобно идентификации в Google Play по имени пакета.
Как правило, айди основывается на домене. Например, annimon.com -> com.annimon, vk.com -> com.vk, limil.spaces.ru -> ru.spaces.limil, github.com/xamgore -> com.github.xamgore. Указывайте такие groupId, домены которых принадлежат вам. Это значит, что org.kalter и com.holdfast скорее всего проверку не пройдут, так как сайты kalter.org и holdfast.com принадлежат невесть кому. В таком случае у вас остаётся вариант использовать groupId по пути к репозиторию на GitHub или BitBucket. Например, https://github.com/KalterFive/Lib_rms -> com.github.kalterfive.
Обращаю внимание, что айди должен быть не с учётом конкретного названия библиотеки, а общий, то есть не com.github.kalterfive.lib_rms, а com.github.kalterfive. Делается это на случай, если вы захотите в будущем опубликовать ещё несколько библиотек.
В прочем, если вы что-то укажете неправильно, команда SonaType вам поможет, либо сама изменит groupId на более общий. Но, всё-таки, во избежание потери времени на рассмотрение заявки, лучше уделить groupId больше внимания.

Остальные поля проблем вызвать не должны - указываем ссылку на репозиторий, где размещён проект.

После создания тикета на почту придёт уведомление.


1.3. Остаётся только подождать, когда рассмотрят вашу заявку. Как я понял, шансы на быстрый ответ увеличиваются ближе к ночи (очевидно, когда у них в часовом поясе рабочий день).
Сотрудник просмотрит всё детально и оставит комментарий с дальнейшими указаниями и просьбой отписаться, когда всё будет сделано.


Шаг 2. Настройка Gradle для публикации
В Maven репозиторий отправляются скомпилированные классы (или aar-архив с классами и ресурсами, если это Android библиотека), исходники (если требуется) и JavaDocs. Всё это дело надо подписать, а чтобы не делать это вручную, необходимо настроить Gradle.

2.1. В корневой директории создаём файл maven_push.gradle с таким содержимым:

93 строки кода

93 строки кода

[копировать] [скачать]

1. apply plugin: 'maven'
2. apply plugin: 'signing'
3.  
4. def sonatypeRepositoryUrl
5. if (isReleaseBuild()) {
6.     println 'RELEASE BUILD'
7.     sonatypeRepositoryUrl = hasProperty('RELEASE_REPOSITORY_URL') ? RELEASE_REPOSITORY_URL
8.             : "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
9. } else {
10.     println 'SNAPSHOT BUILD'
11.     sonatypeRepositoryUrl = hasProperty('SNAPSHOT_REPOSITORY_URL') ? SNAPSHOT_REPOSITORY_URL
12.             : "https://oss.sonatype.org/content/repositories/snapshots/"
13. }
14.  
15. def getRepositoryUsername() {
16.     return hasProperty('nexusUsername') ? nexusUsername : ""
17. }
18.  
19. def getRepositoryPassword() {
20.     return hasProperty('nexusPassword') ? nexusPassword : ""
21. }
22.  
23. afterEvaluate { project ->
24.     uploadArchives {
25.         repositories {
26.             mavenDeployer {
27.                 beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
28.  
29.                 pom.artifactId = POM_ARTIFACT_ID
30.  
31.                 repository(url: sonatypeRepositoryUrl) {
32.                     authentication(userName: getRepositoryUsername(), password: getRepositoryPassword())
33.                 }
34.  
35.                 pom.project {
36.                     name POM_NAME
37.                     packaging POM_PACKAGING
38.                     description POM_DESCRIPTION
39.                     url POM_URL
40.  
41.                     scm {
42.                         url POM_SCM_URL
43.                         connection POM_SCM_CONNECTION
44.                         developerConnection POM_SCM_DEV_CONNECTION
45.                     }
46.  
47.                     licenses {
48.                         license {
49.                             name POM_LICENCE_NAME
50.                             url POM_LICENCE_URL
51.                             distribution POM_LICENCE_DIST
52.                         }
53.                     }
54.  
55.                     developers {
56.                         developer {
57.                             id POM_DEVELOPER_ID
58.                             name POM_DEVELOPER_NAME
59.                         }
60.                     }
61.                 }
62.             }
63.         }
64.     }
65.  
66.     signing {
67.         required { isReleaseBuild() && gradle.taskGraph.hasTask("uploadArchives") }
68.         sign configurations.archives
69.     }
70.  
71.     task androidJavadocs(type: Javadoc) {
72.         options {
73.             linksOffline "http://d.android.com/reference", "${android.sdkDirectory}/docs/reference"
74.         }
75.         source = android.sourceSets.main.java.sourceFiles
76.         classpath += project.files(project.android.getBootClasspath().join(File.pathSeparator))
77.     }
78.  
79.     task androidJavadocsJar(type: Jar, dependsOn: androidJavadocs) {
80.         classifier = 'javadoc'
81.         from androidJavadocs.destinationDir
82.     }
83.  
84.     task androidSourcesJar(type: Jar) {
85.         classifier = 'sources'
86.         from android.sourceSets.main.java.sourceFiles
87.     }
88.  
89.     artifacts {
90.         archives androidSourcesJar
91.         archives androidJavadocsJar
92.     }
93. }

Либо скачайте
maven_push.gradle

2.2. В корневой gradle.properties добавляем константы:
Пример конфигурации.
POM_SCM_CONNECTION и POM_SCM_DEV_CONNECTION можно взять из репозитория на GitHub в панели справа.


2.3. В корневой build.gradle добавляем строки:

2.4. В папке с каждым модулем, который будем публиковать (в моём случае это лишь модуль library) создаём файл gradle.properties и заполняем содержимым:
POM_ARTIFACT_ID в итоге будет подпапкой GROUP_ID, в моём случае получится com.annimon.paperstyle
В рядом лежащий build.gradle добавляем всего одну строчку:

Пример: library/gradle.properties | library/build.gradle


Шаг 3. Подпись модулей
Теперь необходимо создать ключ для подписи и подписать им каждый выгружаемый файл. Как вы поняли, это тоже будет происходить автоматически, надо только всё как следует настроить.

3.0. Для Windows следует поставить программу GPG, на Linux качать ничего не надо, она и так есть в системе. Проверить это можно набрав в консоли gpg --version.


3.1. Генерируем собственный ключ. В консоли набираем gpg --gen-key и проходим простую процедуру.
Сперва попросят выбрать тип создаваемого ключа, затем его размер и срок действия, смело выбирайте значения по умолчанию.

Консоль в текстовом виде

Консоль в текстовом виде

[копировать] [скачать]

1. Please select what kind of key you want:
2.    (1) RSA and RSA (default)
3.    (2) DSA and Elgamal
4.    (3) DSA (sign only)
5.    (4) RSA (sign only)
6. Your selection? 1
7.  
8. RSA keys may be between 1024 and 4096 bits long.
9. What keysize do you want? (2048) 2048
10.  
11. Requested keysize is 2048 bits
12. Please specify how long the key should be valid.
13.          0 = key does not expire
14.       <n>  = key expires in n days
15.       <n>w = key expires in n weeks
16.       <n>m = key expires in n months
17.       <n>y = key expires in n years
18. Key is valid for? (0) 0
19. Key does not expire at all
20. Is this correct? (y/N) y

Затем попросят ввести ваши данные, а именно имя и фамилию, адрес электронной почты и комментарий. В комментарии можно указать ник.

Консоль в текстовом виде

Консоль в текстовом виде

[копировать] [скачать]

1. You need a user ID to identify your key; the software constructs the user ID
2. from the Real Name, Comment and Email Address in this form:
3.     "Heinrich Heine (Der Dichter) <[email protected]>"
4.  
5. Real name: Victor Melnik
6. Email address: annimon119@gmail.com
7. Comment: aNNiMON
8. You selected this USER-ID:
9.     "Victor Melnik (aNNiMON) <[email protected]>"
10.  
11. Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O

Затем нужно придумать пароль, после чего будет весьма интересный сбор случайных данных. Вам придётся проявить активность и двигать мышкой, набирать что-либо на клавиатуре, в общем, генерировать системные события для лучшей защиты ключа.
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
Наконец, после этого появятся заветные строчки

Здесь 2048 - размер ключа, R - тип (выбранный на первом шаге), далее идёт id ключа (910D40ED), это значение нам понадобится для следующего пункта.
Скриншот терминала


3.2. Отправляем публичный ключ на сервер хранения ключей, выполнив команду gpg --keyserver hkp://pool.sks-keyservers.net --send-keys id_ключа


3.3. Заполняем информацию о созданном ключе в конфигах. В пользовательский gradle.properties (C:\Users\<user>\.gradle\gradle.properties или ~/.gradle/gradle.properties) добавляем константы (если файла нет, нужно создать):


Шаг 4. Выгрузка на сервер
4.1. Теперь нужно запустить скрипт отправки библиотеки на сервер. Запускаем задачу uploadArchives

Если всё пройдёт успешно, вы увидите нечто подобное:
У меня получилось со второго раза, почему-то путь к ключу ~/.gnupg/secring.gpg не подхватился, пришлось в ~/.gradle/gradle.properties написать полный путь home/annimon/.gnupg/secring.gpg

4.2. Заходим сюда https://oss.sonatype.org/#stagingRepositories логинимся и ищем свой репозиторий.

Напротив него стоит статус open, нам нужно проверить, всё ли выгрузилось. Чтоб уж точно убедиться в работоспособности, на этом этапе даже можно попробовать подключить свою библиотеку через maven, так как она доступна в публичном отслеживающем (staging) репозитории

Если что-то не так - удалите репозиторий, выделив его в списке и нажав кнопку Drop, затем выгрузите библиотеку по-новой.
Если же всё нормально, тогда выделяем в списке наш репозиторий и нажимаем кнопку Close.

Сервер проведёт свою проверку и если всё будет нормально, уведомит вас письмом на электронную почту.

После этого, точно так же отправляем репозиторий в релиз, нажав ранее недоступную кнопку Release.


4.3. Как только всё будет сделано, возвращаемся к истокам, а именно на баг-трекер https://issues.sonatype.org/browse/OSSRH и оставляем комментарий, о котором просил сотрудник.


Когда всё будет готово к запуску синхронизации, вас оповестят следующим комментарием



Шаг 5. Празднование
На этом процедура публикации вашей первой библиотеки закончена. Радует одно - эти мучения нужно проходить только один раз. Для последующих библиотек создавать задачи и ожидать подтверждений не придётся.
Спустя некоторое время, библиотека появится в публичном репозитории, её можно будет найти в http://search.maven.org/ и в Gradle, Please, а также использовать в своих проектах, добавив строки:

---

Использованные ресурсы1. Публикация артефакта в Maven Central через Sonatype OSS Repository Hosting Service / Хабрахабр
2. Publish an aar file to Maven Central with Gradle
3. OSSRH Guide
4. How to Generate PGP Signatures with Maven | Sonatype Blog