Sonatype Platform Plugin for Jenkins - Nexus Repository

In a Build step section of a Project configuration screen, select Nexus Repository Manager Publisher from the list. Enter the following parameters:

Once you have finished configuring the step as desired, click Save.

Launch a build for your project. When the build completes, you should see output similar to the following confirming the upload succeeded:

In the Build step section of a Project configuration screen, click the Add Build Step dropdown button and then select Create Tag (Nexus Repository Manager 3.x). Enter the following parameters:

1. Nexus Instance: Select the display name of a repository manager instance that was pre-configured in Jenkins global configuration.

2. Tag Name: The name to be given to the created tag (e.g. build-xyz)

3. Tag Attributes File: ( Optional) Additional attributes to include with the tag. Examples could be details about the build, version, or some other detail relevant to your organization's release process or pipeline.

4. Tag Attributes (JSON): (Optional) Similar to the Tag Attributes File option, this field provides a means for specifying additional attributes to include with the tag as JSON within the Jenkins UI.

Once you have finished configuring the step as desired, click Save.

Launch a build for your project. When the build completes, you will see output similar to the following:

In the Build step section of the project configuration screen, click the Add Build Step dropdown button and then select Associate Tag (Nexus Repository Manager 3.x). Enter the following parameters:

1. Nexus Instance: Select the display name of a repository manager instance that was pre-configured in Jenkins global configuration.

2. Tag Name: The name to be given to the created tag (e.g. build-xyz)

3. Search Criteria: One or more Key / Value pairs to search repository manager for the components to associate with the tag.

   The valid Key names are the supported search parameters listed for the Associate Tags REST API.

   Click the Add button in this section to add a new key-value search criteria pair.

   Click the red X icon within each key-value pair section to delete a pair.

Once you have finished configuring the step as desired, click Save.

Launch a build for your project. When the build completes, you will see output similar to the following:

In the Build step section of the configuration screen, click the Add Build Step dropdown button and then select Move Components (Nexus Repository Manager 3.x). Enter the following parameters:

Once you have finished configuring the step as desired, click Save.

Launch a build for your project. When the build completes, you will see output similar to the following which details the components that were moved:

In the Build step section of the configuration screen, click the Add Build Step dropdown button and then select Delete Components (Nexus Repository Manager 3.x). Enter the following parameters:

Once you have finished configuring the step as desired, click Save.

Launch a build for your project. When the build completes, you will see output similar to the following which details the components that were deleted:

To start, create a pipeline project by clicking the New Item link on the Jenkins Dashboard.

Give the project a name and click OK to continue with the configuration.

Pipeline jobs allow you to configure the job via a Groovy script. The script is editable in the Pipeline section.

In the Pipeline section of the configuration screen, we will add several placeholders to get us started. Modify the script to contain following:

node {
    echo 'Staging Components...'
    
    stage ('Creating build tag') {
    }
    stage ('Publishing') {
    }
    stage ('Move') {
    }
    stage ('Delete') {
    } 
}

When complete the Pipeline section should look similar to the following:

At this point, the build script contains placeholders for creating a tag, publishing (and tagging) a component, moving components by tag, and deleting components by tag. In the following steps, each of these placeholders will be populated with the appropriate pipeline script.

First, we'll populate the Creating build tag stage.

Click the Pipeline Syntax link located below the Script textbox.

In the Steps section of the Snippet Generator window, select/enter the following:

1. Sample Step: Select create Tag: Create Tag (Nexus Repository Manager 3.x).

2. Nexus Instance: Select the display name set in global configuration.

3. Tag Name: enter build-125.

4. Attributes: Click the Advanced... button to add some additional attributes. In the text box enter {"createdBy": "JohnSmith"}.

Click the Generate Pipeline Script button. An example pipeline script is shown below:

Copy the generated script and paste it into the Creating build tag stage of your pipeline script.

Completing the Snippet Generator is very similar to completing the Freestyle Build Step configuration. Repeat Steps 7 and 8 for the Publishing, Move, and Delete stages in your pipeline script using the following inputs:

1. Publishing stage

   The generated pipeline script should look similar to the following:

   nexusPublisher nexusInstanceId: 'nx3', nexusRepositoryId: 'maven-releases', packages: [[$class: 'MavenPackage', mavenAssetList: [[classifier: '', extension: '', filePath: '/Users/johnsmith/dev/fancyWidgetProject/fancyWidget.jar']], mavenCoordinate: [artifactId: 'fancyWidget', groupId: 'com.mycompany', packaging: 'jar', version: '1.1']]], tagName: 'build-125'

2. Move stage

   The generated pipeline script should look similar to the following:

   moveComponents destination: 'maven-test', nexusInstanceId: 'nx3', tagName: 'build-123'

3. Delete stage

   The generated pipeline script should look similar to the following:

   deleteComponents nexusInstanceId: 'nx3', tagName: 'build-120'

When we add all the generated scripts into the pipeline configuration window, the completed script should look similar to the following (depending on any changes you may have made to the inputs):

node {
    echo 'Staging Components...'
    
    stage ('Creating build tag') {
        createTag nexusInstanceId: 'nx3', tagAttributesJson: '{"createdBy" : "JohnSmith"}', tagName: 'build-125'
    }
    stage ('Publishing') {
        nexusPublisher nexusInstanceId: 'nx3', nexusRepositoryId: 'maven-releases', packages: [[$class: 'MavenPackage', mavenAssetList: [[classifier: '', extension: '', filePath: '/Users/johnsmith/dev/fancyWidgetProject/fancyWidget.jar']], mavenCoordinate: [artifactId: 'fancyWidget', groupId: 'com.mycompany', packaging: 'jar', version: '1.1']]], tagName: 'build-125'
    }
    stage ('Move') {
        moveComponents destination: 'maven-test', nexusInstanceId: 'nx3', tagName: 'build-123'
    }
    stage ('Delete') {
        deleteComponents nexusInstanceId: 'nx3', tagName: 'build-120'
    } 
}

Launch a build for your project.

Once the job has completed you should see something similar to the following in the Jenkins output console (some additional Jenkins boilerplate logging has been removed for brevity):

Running on Jenkins in /Users/jbryan/.jenkins/workspace/fullPipeline
Staging Components...
Successfully created tag: '{"name":"build-125","attributes":{"createdBy":"JohnSmith"}}'

Uploading Maven asset with groupId: com.mycompany artifactId: fancyWidget version: 1.1 To repository: maven-dev
Successfully Uploaded Maven Assets

Move successful. Destination: 'maven-test' Components moved:
(group: com.mycompany, name: fancyWidget, version: 1.0)

Delete successful. Components deleted:
(group: com.mycompany, name: oldFancyWidget, version: 1.0)

Finished: SUCCESS