java-artifact-publish-plugin

Плагин реализует и настраивает функционал публикации артефакта.

Подключение

Для подключения добавьте в build.gradle:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'ru.yoomoney.gradle.plugins:java-artifact-publish-plugin:4.+'
    }
}
apply plugin: 'ru.yoomoney.gradle.plugins.java-artifact-publish-plugin'

Использование

Плагин создает publication с именем "mainArtifact". Плагин публикует заданный артефакт при помощи таски publishMainArtifactPublicationToMavenRepository. Также публикация будет осуществлена при вызове общей таски publish, наряду с другими существующими в проекте публикациями. Результатом вызовом вышеназванной таски будет отгрузка артефакта в Nexus в репозиторий

• snapshots - для версий с постфиксом -SNAPSHOT
• releases - для всех остальных версий. Дополнительно в сборочной директории будет создан файл version.txt, содержащий полное имя отгруженного артефакта.

Подпись артефактов

Если выгружаемый артефакт необходимо подписать (обязательное требование для, например, выгрузки в MavenCentral), укажите в настройках

javaArtifactPublishSettings {
    signing = true //по умолчанию подпись отключена
}

А также добавьте системные переменные:

• ORG_GRADLE_PROJECT_signingKey - значение ключа в ascii-armored формате
• ORG_GRADLE_PROJECT_signingPassword - passphrase ключа

Для подписи артефакта используется стандартный плагин signing.
Подписаны будут только релизные версии артефактов, т.к. для загрузки snapshot версий подпись не нужна.

Публикация артефакта в staging репозиторий

Если выгружаемый артефакт необходимо публиковать в staging репозиторий, укажите в настройках:

    javaArtifactPublishSettings {
        staging {
            enabled = true // по умолчанию публикация в staging отключена
            nexusUrl = 'https://oss.sonatype.org/service/local/'
        }
    }

Задача publishMainArtifactPublicationToMavenRepository публикует артефакт в созданный staging репозиторий. Для выпуска (release) опубликованного артефакта необходимо вызвать задачу closeAndReleaseMavenStagingRepository.

Задачи создания и закрытия staging репозитория должны быть выполнены в едином gradle процессе, иначе информация о созданном staging репозитория потеряется (связанная задача).

Для публикации артефака в staging репозиторий используется плагин io.github.gradle-nexus.publish-plugin

Конфигурация

Плагин конфигурируется следующим образом:

javaArtifactPublishSettings {
    // Имя пользователя для отгрузки в Nexus, обязательный параметр.
    nexusUser = System.getenv("NEXUS_USER")
    // Пароль пользователя для отгрузки в Nexus, обязательный параметр.
    nexusPassword = System.getenv("NEXUS_PASSWORD")
    // Группа отгружаемого артефакта, обязательный параметр.
    groupId = 'ru.yoomoney.common'
    // Имя отгружаемого артефакта, обязательный параметр.
    artifactId = 'artifact'
    // Вид публикуемого артефакта, необязательный параметр.
    publishingComponent = components.java
    // Репозиторий, в который загружать snapshot версии, обязательный параметр.
    snapshotRepository = "https://yoomoney/repository/snapshots/"
    // Репозиторий, в который загружать release версии, обязательный параметр если публикация в staging выключена 
    releaseRepository = "https://yoomoney/repository/release/"
    staging {
        // Нужно ли публиковать release артефакт в staging репозиторий
        enabled = false // значение по умолчанию
        // URL nexus сервиса для управления staging репозиториями, обязательный параметр если публикация в staging включена
        nexusUrl = 'https://oss.sonatype.org/service/local/'
    }

    //добавление дополнительной информации в pom проекта.
    //по умолчанию дополнительная информация не добавляется (addInfo=false).
    publicationAdditionalInfo {
        addInfo = true
        organizationUrl = "https://github.com/yoomoney"
        license {
            name = "MIT License"
            url = "http://www.opensource.org/licenses/mit-license.php"
        }
        developers {
            developer {
                name = 'Ivan'
                email = '[email protected]'
                organization = 'test'
                organizationUrl = 'https://test.ru'
            }
        }
        description = "description"
    }
}