MavenArtifact ChoiceListProvider

What does this this - Overview

This plugin adds an additional ChoiceListProvider to famous Extensible Choice Parameter plugin.

This Jenkins extension allows you to interact with Service APIs from Maven repositories such as:

• Nexus 2
• Nexus 3
• Maven Central
• Artifactory

It enables searching for artifacts using various parameters, including:

• artifactId
• groupId
• packaging

---

Features

✅ Artifact Search

Search for artifacts in the selected repository using flexible parameters.

✅ Version Selection

The plugin provides a build parameter that lets users choose a version from the available artifacts in the chosen repository.

✅ Artifact URL Retrieval

Once a version is selected, the plugin returns the full URL of the chosen artifact.
This URL is exposed as an environment variable during the build, making it easy to download the artifact using:

wget $ARTIFACT_URL
## or
curl $ARTIFACT_URL

✅ Docker Image Support

The plugin can also retrieve Docker images and list available tags.

Usage

You can use this plugin in:

• Classic Jenkins Jobs
• Declarative Pipelines

Configuration Sample UI

We are using this plugin to let our QA department choose between the various available versions of our software. In combination with the "Publish via SSH" plugin the choosen artifact URL is passed to the testserver which is then able to retrieve the artifact and install it.

Configuration UI Sample

Pipeline Example

Declarative Pipeline

pipeline {
    agent any
    
    parameters {
        nexus3DockerImage(name: 'theDockerImageWithCustomPrefix', url: "https://repo.company.com", imagePrefix: "docker-dev-hosted.repo.company.com/", repository: "ps-docker-dev-hosted", group: "", imageName: 'dn-ps-nagios', credentialsId: "my-credential-id", reverseOrder: true)
        
        nexus3DockerImage(name: 'theDockerImageNoPrefix', url: "https://repo.company.com", imagePrefix: "", repository: "ps-docker-dev-hosted", group: "", imageName: 'dn-ps-nagios', credentialsId: "my-credential-id", reverseOrder: true)
        
        nexus3Generic(name: 'theGenericArtifact', url: "https://repo.company.com", repository: "ps-docker-dev-hosted", assetName: 'dn-ps-nagios', credentialsId: "my-credential-id")
        
        nexus3Maven(name: 'theMavenArtifact', url: "https://repo.company.com", repository: "maven-central-ext-proxy", groupId: "org.apache.logging.log4j", artifactId: 'log4j-core', packaging: 'jar', credentialsId: "my-credential-id")
    }
    
    stages {
        stage("Sample") {
            steps {
                echo "$theDockerImageWithCustomPrefix"
                echo "$theDockerImageNoPrefix"
                echo "$theGenericArtifact"
                echo "$theMavenArtifact"
            }
        }
    }
}

Declarative Pipeline in UI

Declarative Pipeline Console Output

Known Issues

Nexus Snapshots

If you would like to use Snapshot Versions of your artifacts you have to enable the tick-box in the Jenkins Settings. Only with the RESTful interface of Nexus 2 you will be able to retrieve Snapshot versions.

Artifactory

Artifactory API is not returning the correct ArtifactIds but only a URL to a JSON file that contains the DownloadURI of the Artifact. As currently there is no way in the Extensible Choice Plugin to intercept the selected value and because its not performant to query Artifactory for all items in the list for the correct downloadURI, the workaround is like this:

wget `wget -qO - https://repo.jenkins-ci.org/api/storage/releases/org/jenkins-ci/plugins/ant-in-workspace/1.1.0/ant-in-workspace-1.1.0-javadoc.jar | json downloadUri\`

The json command like tool is required:

json --version
json 9.0.6
written by Trent Mick
https://github.com/trentm/json

Continouos Delivery

https://ci.jenkins.io/job/Plugins/job/maven-artifact-choicelistprovider-plugin/

Authors

Stephan Watermeyer (Profile: https://github.com/phreakadelle)

License

Licensed under the MIT License (MIT).