Jenkins Artifactory Plugin - Release Management

Skip to end of metadata
Go to start of metadata

TABLE OF CONTENTS

General

The Artifactory plugin includes release management capabilities for Maven and Gradle jobs that use Subversion, Git or Perforce for VCS.

The plugin lets you manually stage a release build, allowing you to:

  • Change values for the release and next development version
  • Choose a target staging repository for deployment of the release, and
  • Create a VCS tag for the release.

Staged release builds can later on be promoted or rolled-back, changing their release status in Artifactory and, optionally, moving the build artifacts to a different target repository.
Inside Artifactory the history of all build status change activities (staged, promoted, rolled-back, etc.) is recorded and displayed for full traceability.

Maven Release Management

Release management with Maven is done entirely by the plugin and executes the Maven build only once.
These are the basic steps that the plugin performs:

  1. Change the POM versions to the release version (before the build starts)
  2. Trigger the Maven build (with optionally different goals)
  3. Commit/push changes to the tag (Subversion) or the release branch (Git)
  4. Change the POM versions to the next development version
  5. Commit/push changes to the trunk

In case of a failure, the plugin will do its best to rollback the changes (local and committed).

Configuring Maven Jobs

To enable release management in Maven jobs, edit the job configuration and check the "Enable Artifactory release management" checkbox.

Staging a Maven Release Build

Once the release management is enabled, Artifactory release staging link will appear in the left panel (to authorized users).

Clicking on the release staging link will open a new page with configuration options for the release build:

The release staging page displays the last build version (the version is of the root pom and it is taken from the last non-release build).
Most of the fields in the form are filled with the default values.
Version configuration controls how the plugin changes the version in the pom files (global version for all modules, version per module or no version changes).
If create VCS tag is checked (default), the plugin will commit/push the poms with the release version to the VCS system with the commit comment. When using Git, there's also an option to create a release branch.
If the target Artifactory server is the Pro edition, the last section lets you change the target repository (the default is the release repository configured in Artifactory publisher) and to add a staging comment which will be included in the build info deployed to Artifactory.
Click on the "Build and Release to Artifactory" button to trigger the release build.

Promoting a Release Build

After a release build finish successfully it is possible to promote the build. This is not a required step, but very useful if you want to mark the build as released in Artifactory and to move/copy the built artifacts to another repository so the artifacts will be available for the consumers.
To activate the action either click on the icon next to the build number or on the "Artifactory Release Promotion" link on the left panel of a built release job.
Note that Artifactory Pro is required fro promotion.

Clicking on the link will open the promotion page:

Select the target status (Released or Rolled-Back) of the build and optional comment to display in the build in Artifactory. To move or copy the build artifacts select the target repository.

Promoting a Non-Staged Build

Artifactory also allows you to promote a build that has not been through release staging.

To do so, check the Allow promotion of non-staged builds box in the build job configuration dialog.

Gradle Release Management

The release management in Gradle relies on version (and other) properties managed by gradle.properties file. You add all the relevant properties to the release management configuration, and the plugin will read and modify those properties in the gradle.properties file.
These are the basic steps that the plugin performs:

  1. Change the gradle.properties with release values (before the build starts)
  2. Trigger the Gradle build step (with optionally different tasks and options)
  3. Commit/push changes to the tag (Subversion) or the release branch (Git)
  4. Change the gradle.properties with next integration values
  5. Commit/push changes to the trunk

Configuring Gradle Jobs

The release management is also available for Gradle build steps in a free style project. To enable Gradle release management, edit the free style job configuration and check "Gradle-Artifactory Integration" and then "Enabled Release Management" checkbox inside the Gradle-Artifactory integration.

Staging a Gradle Release Build

Once the release management is enabled, Artifactory release staging link will appear in the left panel (to authorized users).
Clicking on the release staging link will open a new page with configuration options for the release build:

The release staging page displays the release and next development properties configured for the job. The values are read from the gradle.properties file and calculation of the release and next integration version is attempted and displayed in the text fields.
If create VCS tag is checked (default), the plugin will commit/push the poms with the release version to the VCS system with the commit comment. When using Git, if 'Use release branch' is checked, the next release version changes will be done on the branch instead of the currently checkout branch.
The last section lets you change the target repository (the default is the release repository configured in Artifactory publisher) and optional staging comment which will be included in the build info deployed to Artifactory.
Click on the "Build and Release to Artifactory" button to trigger the release build.

Promoting a Release Build

Promotion is same as in Maven.

Configuring Authorization

If you're using matrix based security, you'll have to grant permissions for the release and promote actions.

The plugin adds two permission types:

  1. Release - Allows the user to trigger release builds
  2. Promote - Allows the user to promote a build

Working with Subversion

The release management supports Subversion SCM when using one checkout directory.
During the release the plugin will perform the following:

  1. Commit the release version directly to the tag (if create tag is checked). The release version is not committed to the to the working branch.
  2. Commit the next development version to the working branch

Working with Git

To work with Git, the Git plugin (version 1.1.10 or later) has to be configured to build one branch AND to checkout to the same local branch. The remote URL should allow Read+Write access.
The plugin uses the git client installed on the machine and uses its credentials to push back to the remote Git repository.

During the release the plugin will perform the following:

  1. If create branch is checked, create and switch to the release branch
  2. Commit the release version to the current branch
  3. Create a release tag
  4. Push the changes
  5. Switch to the checkout branch and commit the next development version
  6. Push the next development version to the working branch

Note that changes will only be committed if changes were made to the files (pom files or gradle.properties)

Working with Perforce

The release management supports Perforce SCM when using one checkout directory.
During the release the plugin will perform the following:

  1. Commit the release version to the working branch and create a label pointing to the changed files (if create VCS tag is checked).
  2. Commit the next development version to the working branch

Jenkins Artifactory Release Staging API

The Jenkins Artifactory Plugin exposes a Release Management API that provides access to all the features that are available through the Jenkins UI.

The format of the API is as follows:

Release Management API Format
<Jenkins Server>/jenkins/job/<Project Name>/artifactory/staging?<Parameters List>

 where:

Jenkins Server The URL of the Jenkins server running the build
Project Name The name of the Jenkins project being built

Maven Project Parameters

The table below details the parameters that should be provided to the API. These parameters mirror those used with the Jenkins UI.

Mandatory parameters
If you do not specify any of the below parameters, the Release Management API will use the values provided by the configured Artifactory Staging User Plugin.
Name Expected values
versioning NONE: Use existing module versions
GLOBAL: One version for all modules
PER_MODULE : Version per module
releaseVersion Relevant only if versioning is set to GLOBAL
The new release version
nextVersion Relevant only if versioning is set to GLOBAL
The next development version
release.<Artifact GroupID>:<Artifact ID> Relevant only if versioning is set to PER_MODULE
Specifies the new release version for the module using the pattern <Artifact GroupID>:<Artifact ID>
 next.<Artifact GroupID>:<Artifact ID> Relevant only if versioning is set to PER_MODULE
specifies the next development version for the module using the pattern <Artifact GroupID>:<Artifact ID>
 createReleaseBranch true: Create a release branch
false: Do not create a release branch
 releaseBranch The name of the release branch to create
createVcsTag true: Create a VCS tag
false: Do not create a VCS tag
tagUrl The name/URL of the VCS tag to create
tagComment The VCS tag comment
nextDevelCommitComment The comment to use when committing changes for the next development version
repositoryKey Target repository to which the published release artifacts should be uploaded
stagingComment A comment that will be added to the promotion action

Gradle Project Parameters

The list of parameters for Gradle projects are the same as those for Maven projects above with the following exceptions:

Name Expected Values
versioning Not used in Gradle projects
releaseVersion Not used in Gradle projects
nextVersion Not used in Gradle projects
release.<Property version name in gradle.properties> Specifies the new release version for the module using the pattern: release.<Property version name in gradle.properties>
next.<Property version name in gradle.properties> Specifies the next development version for the module using the pattern: next.<Property version name in gradle.properties>

Watch the Screencast

To see the Jenkins Artifactory Release Integration in action you can watch the following screencast.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Nov 08, 2011

    Nicolas Grobisa says:

    <please, erase this comment to avoid confusion. I've already posted in the Ar...

    <please, erase this comment to avoid confusion. I've already posted in the Artifactory users list and now my problem is solved>

  2. Apr 12, 2012

    Jordan Grant says:

    Is there a specific reason that this feature does not work with CVS? I'm attempt...

    Is there a specific reason that this feature does not work with CVS? I'm attempting to update our technology stack, and I'm hesitant to throw git in the mix for team buy-in reasons.  I may try to implement it myself if I'm not missing some reason it cannot be accomplished.

  3. Nov 27, 2014

    michel morizot says:

    Hi, I'm using version 2.0.4 of the artifactory release plugin with artifactory ...

    Hi,

    I'm using version 2.0.4 of the artifactory release plugin with artifactory OSS 3.2.0.

    It seems that since i upgraded to jenkins 1.590, the build release page is no longer populated .

    Last build version is properly set, but all the other fields are empty.

    Can you reproduce?

    the plugin would at least display a target repo for deploying (the one set  for releases in the job configuration)

  4. Nov 28, 2014

    michel morizot says:

    found this log in the jenkins system log when invoquing the "artifactory release...

    found this log in the jenkins system log when invoquing the "artifactory release staging" page :Nov 28, 2014 10:14:21 AM WARNING hudson.ExpressionFactory2$JexlExpression evaluate
    Caught exception evaluating: !it.artifactoryPro ? 'disabled' : null in /view/BUILD-COMMON_COMPONENTS/job/XXXXXX/release/. Reason: java.lang.reflect.InvocationTargetException
    java.lang.reflect.InvocationTargetException
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:606)