About

This is a Gradle plugin to publish files to a Nexus raw repository. It has been build to upload documentation to a Nexus repository of type raw, but it can be used for any other file type as well. The plugin is compatible with Sonatype Nexus version 3.

This is a very early version of the plugin. In case you miss any features, feel free to open an issue or a pull request.

Installation

The plugin is availabe on the Open eCard Nexus Repository. To use it, add the following entry to your settings.gradle.kts:

pluginManagement {
    repositories {
        maven {
            url = uri("https://mvn.ecsec.de/repository/openecard-public/")
        }
    }
}

The plugin can then be loaded in the build.gradle.kts file as follows:

plugins {
    id("de.ecsec.nexus-raw-publish") version "0.9.1"
}

Configuration

The plugin can be configured using the publishNexusRaw extension and identical properties in the PublishNexusRawTask.

The following properties are available:

• nexusUrl (String): The base URL of the Nexus installation. Typically something like https://mvn.example.com/.
• repoName (String): The name of the repository.
• repoFolder (String): The folder in the repository to upload to.
• username (String): The username to authenticate with.
• password (String): The password to authenticate with.
• inputDir (Directory): The directory whose content to upload to the Nexus repository.

The plugin automatically registers a task with the name publishNexusRaw, which uses the configuration values from the extension. The example section below provides more details on how the plugin could be configured.

Example

The following example uses custom tasks to publish the same artifact under different paths. As it can be seen in the task definitions, the publish jobs depend on the asciidoctor task to build the to be uploaded files.

import de.ecsec.PublishNexusRawTask

publishNexusRaw {
    nexusUrl = "https://mvn.example.com/"
    repoName = "docs-repo"
    username = System.getenv("MVN_EXAMPLE_USERNAME") ?: project.findProperty("mvnUsernameExample") as String?
    password = System.getenv("MVN_EXAMPLE_PASSWORD") ?: project.findProperty("mvnPasswordExample") as String?
    inputDir = layout.buildDirectory.dir("docs/asciidoc")
}

tasks.register("publishNexusRawVersion", PublishNexusRawTask::class) {
    group = "publishing"
    repoFolder = "mysoftware/doc/${project.version}"
    dependsOn("asciidoctor")
}
tasks.register("publishNexusRawLatest", PublishNexusRawTask::class) {
    group = "publishing"
    repoFolder = "mysoftware/doc/latest"
    dependsOn("asciidoctor")
}
tasks.register("publishNexusRawDev", PublishNexusRawTask::class) {
    group = "publishing"
    repoFolder = "mysoftware/doc/dev"
    dependsOn("asciidoctor")
}

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.