Nexus3

Deploys staged artifacts to Sonatype Nexus3 Repository Manager instance.

Deploying signature and checksum files is disabled.
This feature is primarily intended for deploying artifacts such as JARs and POMs to a Maven compatible repository, but you may upload any other files as long as they can be resolved.
Publication of snapshots is not allowed.

Configuration

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

# 
deploy:
  maven:
    # 
    nexus3:
      # Deployers require a name.
      # 
      app:

        # Enables or disables the deployer.
        # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        # Defaults to `NEVER`.
        #  
        active: ALWAYS

        # URL where the Nexus3 service is enabled.
        # If left unspecified, the `JRELEASER_NEXUS3_${name}_URL`
        # environment variable must be defined.
        #  
        url: http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases

        # Activates publication of snapshot artifacts.
        # Defaults to `false`.
        # 
        snapshotSupported: true

        # The username required for authorization.
        # If left unspecified, the `JRELEASER_NEXUS3_${name}_USERNAME`
        # environment variable must be defined.
        #  
        username: __USE_ENVIRONMENT_VARIABLE__

        # Password for login into the NEXUS3 service.
        # If left unspecified, the `JRELEASER_NEXUS3_${name}_PASSWORD`
        # environment variable must be defined.
        #  
        password: __USE_ENVIRONMENT_VARIABLE__

        # The authorization method to use.
        # Supported values are [`NONE`, `BASIC`, `BEARER`].
        # `Basic` requires both username & password.
        # `BEARER` requires a token (set as password).
        # Defaults to `BASIC`.
        # 
        authorization: BASIC

        # Signs artifacts with the configured credentials.
        # The Signing section must be configured as well.
        # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
        # 
        sign: false

        # Checksums all artifacts with `MD5`, `SHA-1`, `SHA-256`, and `SHA-512`.
        # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
        # 
        checksums: false

        # Verifies that a matching `-sources.jar` artifact is staged.
        # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
        # 
        sourceJar: false

        # Verifies that a matching `-javadoc.jar` artifact is staged.
        # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
        # 
        javadocJar: false

        # Verifies that POM files comply with the minimum requirements for publication
        # to Maven Central. Checks rules using PomChecker.
        # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
        # 
        verifyPom: false

        # Verifies pom files, signs all artifacts, verifies that matching `-sources.jar` and
        # `-javadoc.jar` artifacts are also staged.
        # Defaults to `false`.
        # 
        applyMavenCentralRules: false

        # Override artifact configuration
        # 
        artifactOverrides:
            # Match artifact by groupId
            # If undefined, will use `#{project.java.groupId}`.
            # 
          - groupId: com.acme

            # Match artifact by artifactId
            # 
            artifactId: app

            # Verifies that a matching `.jar` artifact is staged.
            # 
            jar: false

            # Verifies that a matching `-sources.jar` artifact is staged.
            # 
            sourceJar: false

            # Verifies that a matching `-javadoc.jar` artifact is staged.
            # 
            javadocJar: false

            # Verifies that POM files comply with the minimum requirements for publication
            # to Maven Central. Checks rules using PomChecker.
            # 
            verifyPom: false

        # List of directories where staged artifacts can be found.
        # 
        stagingRepositories:
          - target/staging-deploy

        # Defines the connection timeout in seconds.
        # Defaults to `20`.
        # 
        connectTimeout: 20

        # Defines the read timeout in seconds.
        # Defaults to `60`.
        # 
        readTimeout: 60

        # Additional properties used when evaluating templates.
        # 
        extraProperties:
          # Key will be capitalized and prefixed with `nexus3`, i.e, `nexus3Foo`.
          foo: bar
# Deployers require a name.
# 
[deploy.maven.nexus3.app]

  # Enables or disables the deployer.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  #  
  active = "ALWAYS"

  # URL where the Nexus3 service is enabled.
  #  
  url = "http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases"

  # Activates publication of snapshot artifacts.
  # Defaults to `false`.
  # 
  snapshotSupported = true

  # The username required for authorization.
  #  
  username = "__USE_ENVIRONMENT_VARIABLE__"

  # Password for login into the NEXUS3 service.
  #  
  password = "__USE_ENVIRONMENT_VARIABLE__"

  # The authorization method to use.
  # Supported values are [`NONE`, `BASIC`, `BEARER`].
  # `Basic` requires both username & password.
  # `BEARER` requires a token (set as password).
  # Defaults to `BASIC`.
  # 
  authorization = "BASIC"

  # Signs artifacts with the configured credentials.
  # The Signing section must be configured as well.
  # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
  # 
  sign = false

  # Checksums all artifacts with `MD5`, `SHA-1`, `SHA-256`, and `SHA-512`.
  # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
  # 
  checksums = false

  # Verifies that a matching `-sources.jar` artifact is staged.
  # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
  # 
  sourceJar = false

  # Verifies that a matching `-javadoc.jar` artifact is staged.
  # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
  # 
  javadocJar = false

  # Verifies that POM files comply with the minimum requirements for publication
  # to Maven Central. Checks rules using PomChecker.
  # Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
  # 
  verifyPom = false

  # Verifies pom files, signs all artifacts, verifies that matching `-sources.jar` and
  # `-javadoc.jar` artifacts are also staged.
  # Defaults to `false`.
  # 
  applyMavenCentralRules = false

  # Override artifact configuration
  # 
  [[deploy.maven.nexus3.app.artifactOverrides]]

    # Match artifact by groupId
    # If undefined, will use `#{project.java.groupId}`.
    # 
    groupId = "com.acme"

    # Match artifact by artifactId
    # 
    artifactId = "app"

    # Verifies that a matching `.jar` artifact is staged.
    # 
    jar = false

    # Verifies that a matching `-sources.jar` artifact is staged.
    # 
    sourceJar = false

    # Verifies that a matching `-javadoc.jar` artifact is staged.
    # 
    javadocJar = false

    # Verifies that POM files comply with the minimum requirements for publication
    # to Maven Central. Checks rules using PomChecker.
    # 
    verifyPom = false

  # List of directories where staged artifacts can be found.
  # 
  stagingRepositories = ["target/staging-deploy"]

  # Defines the connection timeout in seconds.
  # Defaults to `20`.
  # 
  connectTimeout = 20

  # Defines the read timeout in seconds.
  # Defaults to `60`.
  # 
  readTimeout = 60

  # Additional properties used when evaluating templates.
  # 
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `nexus3`, i.e, `nexus3Foo`.
{
  // 
  "deploy": {
    "maven": {
      // 
      "nexus3": {
        // Deployers require a name.
        // 
        "app": {

          // Enables or disables the deployer.
          // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          // Defaults to `NEVER`.
          //  
          "active": "ALWAYS",

          // URL where the Nexus3 service is enabled.
          //  
          "url": "http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases",

          // Activates publication of snapshot artifacts.
          // Defaults to `false`.
          // 
          "snapshotSupported": true,

          // The username required for authorization.
          //  
          "username": "__USE_ENVIRONMENT_VARIABLE__",

          // Password for login into the NEXUS3 service.
          //  
          "password": "__USE_ENVIRONMENT_VARIABLE__",

          // The authorization method to use.
          // Supported values are [`NONE`, `BASIC`, `BEARER`].
          // `Basic` requires both username & password.
          // `BEARER` requires a token (set as password).
          // Defaults to `BASIC`.
          // 
          "authorization": "BASIC",

          // Signs artifacts with the configured credentials.
          // The Signing section must be configured as well.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          "sign": false,

          // Checksums all artifacts with `MD5`, `SHA-1`, `SHA-256`, and `SHA-512`.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          "checksums": false,

          // Verifies that a matching `-sources.jar` artifact is staged.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          "sourceJar": false,

          // Verifies that a matching `-javadoc.jar` artifact is staged.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          "javadocJar": false,

          // Verifies that POM files comply with the minimum requirements for publication
          // to Maven Central. Checks rules using PomChecker.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          "verifyPom": false,

          // Verifies pom files, signs all artifacts, verifies that matching `-sources.jar` and
          // `-javadoc.jar` artifacts are also staged.
          // Defaults to `false`.
          // 
          "applyMavenCentralRules": false,

          // Override artifact configuration
          // 
          "artifactOverrides": [
            {
              // Match artifact by groupId
              // If undefined, will use `#{project.java.groupId}`.
              // 
              "groupId": "com.acme",

              // Match artifact by artifactId
              // 
              "artifactId": "app",

              // Verifies that a matching `.jar` artifact is staged.
              // 
              "jar": false,

              // Verifies that a matching `-sources.jar` artifact is staged.
              // 
              "sourceJar": false,

              // Verifies that a matching `-javadoc.jar` artifact is staged.
              // 
              "javadocJar": false,

              // Verifies that POM files comply with the minimum requirements for publication
              // to Maven Central. Checks rules using PomChecker.
              // 
              "verifyPom": false
            }
          ]

          // List of directories where staged artifacts can be found.
          // 
          "stagingRepositories": [
            "target/staging-deploy"
          ],

          // Defines the connection timeout in seconds.
          // Defaults to `20`.
          // 
          "connectTimeout": 20,

          // Defines the read timeout in seconds.
          // Defaults to `60`.
          // 
          "readTimeout": 60,
          // Additional properties used when evaluating templates.
          // 
          "extraProperties": {
            // Key will be capitalized and prefixed with `nexus3`, i.e, `nexus3Foo`.
            "foo": "bar"
          }
        }
      }
    }
  }
}
<jreleaser>
  <!--
    
  -->
  <deploy>
    <maven>
      <!--
        
      -->
      <nexus3>
        <!--
          Deployers require a name.
          
        -->
        <app>
          <!--
            Enables or disables the deployer.
            Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
            Defaults to `NEVER`.
             
          -->
          <active>ALWAYS</active>

          <!--
            URL where the Nexus3 service is enabled.
             
          -->
          <url>http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases</url>

          <!--
            Activates publication of snapshot artifacts.
            Defaults to `false`.
            
          -->
          <snapshotSupported>true</snapshotSupported>

          <!--
            The username required for authorization.
             
          -->
          <username>__USE_ENVIRONMENT_VARIABLE__</username>

          <!--
            Password for login into the NEXUS3 service.
             
          -->
          <password>__USE_ENVIRONMENT_VARIABLE__</password>

          <!--
            The authorization method to use.
            Supported values are [`NONE`, `BASIC`, `BEARER`].
            `Basic` requires both username & password.
            `BEARER` requires a token (set as password).
            Defaults to `BASIC`.
            
          -->
          <authorization>BASIC</authorization>

          <!--
            Signs artifacts with the configured credentials.
            The Signing section must be configured as well.
            Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
            
          -->
          <sign>false</sign>

          <!--
            Checksums all artifacts with `MD5`, `SHA-1`, `SHA-256`, and `SHA-512`.
            Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
            
          -->
          <checksums>false</checksums>

          <!--
            Verifies that a matching `-sources.jar` artifact is staged.
            Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
            
          -->
          <sourceJar>false</sourceJar>

          <!--
            Verifies that a matching `-javadoc.jar` artifact is staged.
            Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
            
          -->
          <javadocJar>false</javadocJar>

          <!--
            Verifies that POM files comply with the minimum requirements for publication
            to Maven Central. Checks rules using PomChecker.
            Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
            
          -->
          <verifyPom>false</verifyPom>

          <!--
            Verifies pom files, signs all artifacts, verifies that matching `-sources.jar` and
            `-javadoc.jar` artifacts are also staged.
            Defaults to `false`.
            
          -->
          <applyMavenCentralRules>false</applyMavenCentralRules>

          <!--
            Override artifact configuration
            
          -->
          <artifactOverrides>
            <artifactOverride>
              <!--
                Match artifact by groupId
                If undefined, will use `#{project.java.groupId}`.
                
              -->
              <groupId>com.acme</groupId>

              <!--
                Match artifact by artifactId
                
              -->
              <artifactId>app</artifactId>

              <!--
                Verifies that a matching `.jar` artifact is staged.
                
              -->
              <jar>false</jar>

              <!--
                Verifies that a matching `-sources.jar` artifact is staged.
                
              -->
              <sourceJar>false</sourceJar>

              <!--
                Verifies that a matching `-javadoc.jar` artifact is staged.
                
              -->
              <javadocJar>false</javadocJar>

              <!--
                Verifies that POM files comply with the minimum requirements for publication
                to Maven Central. Checks rules using PomChecker.
                
              -->
              <verifyPom>false</verifyPom>
            </artifactOverride>
          </artifactOverrides>

          <!--
            List of directories where staged artifacts can be found.
            
          -->
          <stagingRepositories>
            <stagingRepository>target/staging-deploy</stagingRepository>
          </stagingRepositories>

          <!--
            Defines the connection timeout in seconds.
            Defaults to `20`.
            
          -->
          <connectTimeout>20</connectTimeout>

          <!--
            Defines the read timeout in seconds.
            Defaults to `60`.
            
          -->
          <readTimeout>60</readTimeout>

          <!--
            Additional properties used when evaluating templates.
            
          -->
          <extraProperties>
            <!--
              Key will be capitalized and prefixed with `nexus3`, i.e, `nexus3Foo`.
            -->
            <foo>bar</foo>
          </extraProperties>
        </app>
      </nexus3>
    </maven>
  </deploy>
</jreleaser>
jreleaser {
  // 
  deploy {
    maven {
      // 
      nexus3 {
        // Deployers require a name.
        // 
        app {

          // Enables or disables the deployer.
          // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          // Defaults to `NEVER`.
          //  
          active = 'ALWAYS'

          // URL where the Nexus3 service is enabled.
          //  
          url = 'http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases'

          // Activates publication of snapshot artifacts.
          // Defaults to `false`.
          // 
          snapshotSupported = true

          // The username required for authorization.
          //  
          username = '__USE_ENVIRONMENT_VARIABLE__'

          // Password for login into the NEXUS3 service.
          //  
          password = '__USE_ENVIRONMENT_VARIABLE__'

          // The authorization method to use.
          // Supported values are [`NONE`, `BASIC`, `BEARER`].
          // `Basic` requires both username & password.
          // `BEARER` requires a token (set as password).
          // Defaults to `BASIC`.
          // 
          authorization = 'BASIC'

          // Signs artifacts with the configured credentials.
          // The Signing section must be configured as well.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          sign = false

          // Checksums all artifacts with `MD5`, `SHA-1`, `SHA-256`, and `SHA-512`.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          checksums = false

          // Verifies that a matching `-sources.jar` artifact is staged.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          sourceJar = false

          // Verifies that a matching `-javadoc.jar` artifact is staged.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          javadocJar = false

          // Verifies that POM files comply with the minimum requirements for publication
          // to Maven Central. Checks rules using PomChecker.
          // Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
          // 
          verifyPom = false

          // Verifies pom files, signs all artifacts, verifies that matching `-sources.jar` and
          // `-javadoc.jar` artifacts are also staged.
          // Defaults to `false`.
          // 
          applyMavenCentralRules = false

          // Override artifact configuration
          // 
          artifactOverride {
            // Match artifact by groupId
            // If undefined, will use `#{project.java.groupId}`.
            // 
            groupId = 'com.acme'

            // Match artifact by artifactId
            // 
            artifactId = 'app'

            // Verifies that a matching `.jar` artifact is staged.
            // 
            jar = false

            // Verifies that a matching `-sources.jar` artifact is staged.
            // 
            sourceJar = false

            // Verifies that a matching `-javadoc.jar` artifact is staged.
            // 
            javadocJar = false

            // Verifies that POM files comply with the minimum requirements for publication
            // to Maven Central. Checks rules using PomChecker.
            // 
            verifyPom = false
          }

          // List of directories where staged artifacts can be found.
          // 
          stagingRepository('target/staging-deploy')

          // Defines the connection timeout in seconds.
          // Defaults to `20`.
          // 
          connectTimeout = 20

          // Defines the read timeout in seconds.
          // Defaults to `60`.
          // 
          readTimeout = 60

          // Additional properties used when evaluating templates.
          // Key will be capitalized and prefixed with `nexus3`, i.e, `nexus3Foo`.
          // 
          extraProperties.put('foo', 'bar')
        }
      }
    }
  }
}

Environment

When not explicitly set, the value of the following properties may be resolved from an environment variable or a system property as shown in the table. The system property takes precedence over the environment variable.

System Property Environment Variable

active

jreleaser.deploy.maven.nexus3.${name}.active
jreleaser.deploy.maven.nexus3.active

JRELEASER_DEPLOY_MAVEN_NEXUS3_${name}_ACTIVE
JRELEASER_DEPLOY_MAVEN_NEXUS3_ACTIVE

url

jreleaser.deploy.maven.nexus3.${name}.url
jreleaser.deploy.maven.nexus3.url
jreleaser.nexus3.${name}.url
jreleaser.nexus3.url

JRELEASER_DEPLOY_MAVEN_NEXUS3_${name}_URL
JRELEASER_DEPLOY_MAVEN_NEXUS3_URL
JRELEASER_NEXUS3_${name}_URL
JRELEASER_NEXUS3_URL

username

jreleaser.deploy.maven.nexus3.${name}.username
jreleaser.deploy.maven.nexus3.username
jreleaser.nexus3.${name}.username
jreleaser.nexus3.username

JRELEASER_DEPLOY_MAVEN_NEXUS3_${name}_USERNAME
JRELEASER_DEPLOY_MAVEN_NEXUS3_USERNAME
JRELEASER_NEXUS3_${name}_USERNAME
JRELEASER_NEXUS3_USERNAME

password

jreleaser.deploy.maven.nexus3.${name}.password
jreleaser.deploy.maven.nexus3.${name}.token
jreleaser.deploy.maven.nexus3.password
jreleaser.deploy.maven.nexus3.token
jreleaser.nexus3.${name}.password
jreleaser.nexus3.${name}.token
jreleaser.nexus3.password
jreleaser.nexus3.token

JRELEASER_DEPLOY_MAVEN_NEXUS3_${name}_PASSWORD
JRELEASER_DEPLOY_MAVEN_NEXUS3_${name}_TOKEN
JRELEASER_DEPLOY_MAVEN_NEXUS3_PASSWORD
JRELEASER_DEPLOY_MAVEN_NEXUS3_TOKEN
JRELEASER_NEXUS3_${name}_PASSWORD
JRELEASER_NEXUS3_${name}_TOKEN
JRELEASER_NEXUS3_PASSWORD
JRELEASER_NEXUS3_TOKEN
Substitute ${name} for the value of the named instance.

Space (' '), underscore (_), and dash (-) will be replaced by dot (.) to separate tokens in the System property. Space (' '), dash (-), and dot (.) will be replaced by underscore (_) to separate tokens in the environment variable, such that:

${name} System Property Environment Variable

foobar

foobar

FOOBAR

fooBar

foobar

FOOBAR

foo bar

foo.bar

FOO_BAR

foo-bar

foo.bar

FOO_BAR

foo_bar

foo.bar

FOO_BAR

foo.bar

foo.bar

FOO_BAR

Example

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

deploy:
  maven:
    nexus3:
      app:
        active: ALWAYS
        url: http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases
        stagingRepositories:
          - target/staging-deploy
[deploy.maven.nexus3.app]
  active = "ALWAYS"
  url = "http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases"
  stagingRepositories = ["target/staging-deploy"]
{
  "jreleaser": {
    "deploy": {
      "maven": {
        "nexus3": {
          "app": {
            "active": "ALWAYS",
            "url": "http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases",
            "stagingRepositories": [
              "target/staging-deploy"
            ]
          }
        }
      }
    }
  }
}
<jreleaser>
  <deploy>
    <maven>
      <nexus3>
        <app>
          <active>ALWAYS</active>
          <url>http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases</url>
          <stagingRepositories>target/staging-deploy</stagingRepositories>
        </app>
      </nexus3>
    </maven>
  </deploy>
</jreleaser>
jreleaser {
  deploy {
    maven {
      nexus3 {
        app {
          active = 'ALWAYS'
          url = 'http://my-nexus3.acme.com:8081/service/rest/v1/components?repository=maven-releases'
          stagingRepository('target/staging-deploy')
        }
      }
    }
  }
}

Any of the following environment variables may be defined to supply values for username and password:

  • JRELEASER_DEPLOY_MAVEN_NEXUS3_APP_USERNAME

  • JRELEASER_DEPLOY_MAVEN_NEXUS3_USERNAME

  • JRELEASER_NEXUS3_APP_USERNAME

  • JRELEASER_NEXUS3_USERNAME

  • JRELEASER_DEPLOY_MAVEN_NEXUS3_APP_PASSWORD

  • JRELEASER_DEPLOY_MAVEN_NEXUS3_APP_TOKEN

  • JRELEASER_DEPLOY_MAVEN_NEXUS3_PASSWORD

  • JRELEASER_DEPLOY_MAVEN_NEXUS3_TOKEN

  • JRELEASER_NEXUS3_APP_PASSWORD

  • JRELEASER_NEXUS3_APP_TOKEN

  • JRELEASER_NEXUS3_PASSWORD

  • JRELEASER_NEXUS3_TOKEN