Azure

Deploys staged artifacts to Azure DevOps.

Prerequisites:

  • A user + password / token with grants to deploy packages.

This feature does not support deploying artifacts other than JARs and POMs to a Maven compatible repository.
Publication of snapshots is not allowed.

Configuration

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

# 
deploy:
  maven:
    # 
    pomchecker:
      # Defines the tool version to use.
      # 
      version: 1.9.0

      # Fail the release if pomchecker outputs a warning.
      # Defaults to `true`.
      # 
      failOnWarning: false

      # Fail the release if pomchecker outputs an error.
      # Defaults to `true`.
      # 
      failOnError: false

    # 
    azure:
      # 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 Azure service is enabled.
        # If left unspecified, the `JRELEASER_AZURE_${name}_URL`
        # environment variable must be defined.
        #  
        url: https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1

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

        # Password for login into the AZURE service.
        # If left unspecified, the `JRELEASER_AZURE_${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 fules 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 `-sources.jar` artifact is staged.
            # Defaults to `false`.
            # 
            sourceJar: false

            # Verifies that a matching `-javadoc.jar` artifact is staged.
            # Defaults to `false`.
            # 
            javadocJar: 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 `azure`, i.e, `azureFoo`.
          foo: bar
[deploy.maven]
  # Defines the tool version to use.
  # 
  pomchecker.version = "1.9.0"

  # Fail the release if pomchecker outputs a warning.
  # Defaults to `true`.
  # 
  pomchecker.failOnWarning = false

  # Fail the release if pomchecker outputs an error.
  # Defaults to `true`.
  # 
  pomchecker.failOnError = false

# Deployers require a name.
# 
[deploy.maven.azure.app]

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

  # URL where the Azure service is enabled.
  #  
  url = "https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1"

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

  # Password for login into the AZURE 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 fules 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.azure.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 `-sources.jar` artifact is staged.
    # Defaults to `false`.
    # 
    sourceJar = false

    # Verifies that a matching `-javadoc.jar` artifact is staged.
    # Defaults to `false`.
    # 
    javadocJar = 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 `azure`, i.e, `azureFoo`.
{
  // 
  "deploy": {
    "maven": {
      // 
      "pomchecker": {
        // Defines the tool version to use.
        // 
        "version": "1.9.0",

        // Fail the release if pomchecker outputs a warning.
        // Defaults to `true`.
        // 
        "failOnWarning": false,

        // Fail the release if pomchecker outputs an error.
        // Defaults to `true`.
        // 
        "failOnError": false
      },

      // 
      "azure": {
        // 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 Azure service is enabled.
          //  
          "url": "https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1",

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

          // Password for login into the AZURE 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 fules 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 `-sources.jar` artifact is staged.
              // Defaults to `false`.
              // 
              "sourceJar": false,

              // Verifies that a matching `-javadoc.jar` artifact is staged.
              // Defaults to `false`.
              // 
              "javadocJar": 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 `azure`, i.e, `azureFoo`.
            "foo": "bar"
          }
        }
      }
    }
  }
}
<jreleaser>
  <!--
    
  -->
  <deploy>
    <maven>
      <!--
        
      -->
      <pomchecker>
        <!--
          Defines the tool version to use.
          
        -->
        <version>1.9.0</version>

        <!--
          Fail the release if pomchecker outputs a warning.
          Defaults to `true`.
          
        -->
        <failOnWarning>false</failOnWarning>

        <!--
          Fail the release if pomchecker outputs an error.
          Defaults to `true`.
          
        -->
        <failOnError>false</failOnError>
      </pomchecker>
      <!--
        
      -->
      <azure>
        <!--
          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 Azure service is enabled.
             
          -->
          <url>https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1</url>

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

          <!--
            Password for login into the AZURE 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 fules 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 `-sources.jar` artifact is staged.
                Defaults to `false`.
                
              -->
              <sourceJar>false</sourceJar>

              <!--
                Verifies that a matching `-javadoc.jar` artifact is staged.
                Defaults to `false`.
                
              -->
              <javadocJar>false</javadocJar>
            </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 `azure`, i.e, `azureFoo`.
            -->
            <foo>bar</foo>
          </extraProperties>
        </app>
      </azure>
    </maven>
  </deploy>
</jreleaser>
jreleaser {
  // 
  deploy {
    maven {
      // 
      pomchecker {
        // Defines the tool version to use.
        // 
        version = '1.9.0'

        // Fail the release if pomchecker outputs a warning.
        // Defaults to `true`.
        // 
        failOnWarning = false

        // Fail the release if pomchecker outputs an error.
        // Defaults to `true`.
        // 
        failOnError = false
      }

      // 
      azure {
        // 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 Azure service is enabled.
          //  
          url = 'https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1'

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

          // Password for login into the AZURE 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 fules 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 `-sources.jar` artifact is staged.
            // Defaults to `false`.
            // 
            sourceJar = false

            // Verifies that a matching `-javadoc.jar` artifact is staged.
            // Defaults to `false`.
            // 
            javadocJar = 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 `azure`, i.e, `azureFoo`.
          // 
          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.azure.${name}.active
jreleaser.deploy.maven.azure.active

JRELEASER_DEPLOY_MAVEN_AZURE_${name}_ACTIVE
JRELEASER_DEPLOY_MAVEN_AZURE_ACTIVE

url

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

JRELEASER_DEPLOY_MAVEN_AZURE_${name}_URL
JRELEASER_DEPLOY_MAVEN_AZURE_URL
JRELEASER_AZURE_${name}_URL
JRELEASER_AZURE_URL

username

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

JRELEASER_DEPLOY_MAVEN_AZURE_${name}_USERNAME
JRELEASER_DEPLOY_MAVEN_AZURE_USERNAME
JRELEASER_AZURE_${name}_USERNAME
JRELEASER_AZURE_USERNAME

password

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

JRELEASER_DEPLOY_MAVEN_AZURE_${name}_PASSWORD
JRELEASER_DEPLOY_MAVEN_AZURE_${name}_TOKEN
JRELEASER_DEPLOY_MAVEN_AZURE_PASSWORD
JRELEASER_DEPLOY_MAVEN_AZURE_TOKEN
JRELEASER_AZURE_${name}_PASSWORD
JRELEASER_AZURE_${name}_TOKEN
JRELEASER_AZURE_PASSWORD
JRELEASER_AZURE_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:
    azure:
      app:
        active: ALWAYS
        url: https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1
        stagingRepositories:
          - target/staging-deploy
[deploy.maven.azure.app]
  active = "ALWAYS"
  url = "https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1"
  stagingRepositories = ["target/staging-deploy"]
{
  "jreleaser": {
    "deploy": {
      "maven": {
        "azure": {
          "app": {
            "active": "ALWAYS",
            "url": "https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1",
            "stagingRepositories": [
              "target/staging-deploy"
            ]
          }
        }
      }
    }
  }
}
<jreleaser>
  <deploy>
    <maven>
      <azure>
        <app>
          <active>ALWAYS</active>
          <url>https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1</url>
          <stagingRepositories>target/staging-deploy</stagingRepositories>
        </app>
      </azure>
    </maven>
  </deploy>
</jreleaser>
jreleaser {
  deploy {
    maven {
      azure {
        app {
          active = 'ALWAYS'
          url = 'https://pkgs.dev.azure.com/duke/_packaging/duke/maven/v1'
          stagingRepository('target/staging-deploy')
        }
      }
    }
  }
}

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

  • JRELEASER_DEPLOY_MAVEN_AZURE_APP_USERNAME

  • JRELEASER_DEPLOY_MAVEN_AZURE_USERNAME

  • JRELEASER_AZURE_APP_USERNAME

  • JRELEASER_AZURE_USERNAME

  • JRELEASER_DEPLOY_MAVEN_AZURE_APP_PASSWORD

  • JRELEASER_DEPLOY_MAVEN_AZURE_APP_TOKEN

  • JRELEASER_DEPLOY_MAVEN_AZURE_PASSWORD

  • JRELEASER_DEPLOY_MAVEN_AZURE_TOKEN

  • JRELEASER_AZURE_APP_PASSWORD

  • JRELEASER_AZURE_APP_TOKEN

  • JRELEASER_AZURE_PASSWORD

  • JRELEASER_AZURE_TOKEN