Release Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID release Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
2.5.4 (archives)
Oct 26, 2015
javadoc (version:1.0)
promoted-builds (version:2.0, optional)
maven-plugin (version:1.481)
dashboard-view (version:2.0, optional)
Source Code
Issue Tracking
Pull Requests
Open Issues
Pull Requests
Peter Hayes (id: petehayes)
Usage Installations 2014-Nov 3319
2014-Dec 3309
2015-Jan 3500
2015-Feb 3486
2015-Mar 3641
2015-Apr 3623
2015-May 3653
2015-Jun 3738
2015-Jul 3737
2015-Aug 3700
2015-Sep 3898
2015-Oct 3904

This plugin adds the ability to wrap your job with pre- and post- build steps which are only executed when a manual release build is triggered.

Additional plugin integration
Supports the Dashboard View with the Recent Releases portlet and the Promoted Builds Plugin with the Release build condition.

Configure the job to enable releasing

On the job configuration page, enable the release build configuration under the Build Wrapper heading and add your required release version template string, release parameters, pre and post build steps that you need to complete a release.

Release Version Template

The release version template was added in version 1.7 of the release plugin.  This parameter lets you define how the release plugin identifies the release of the project.  This is done by building a parameter based template which is resolved at release time to a fully resolved string.  For instance, the template can be: Release: ${releaseVersion}.  This will instruct the release plugin to use the value of the parameter name releaseVersion to come up with the fully identifying string which will then be used as a description of the release build and as a tooltip on the release build icon on the historical build list.

Release Parameters

The release parameters let you define various parameters that are presented to the user when a release is requested.  The list of available parameter types are the same as those available in the parameterized build option for Jenkins.

Build Steps

The build steps section is used to define arbitrary actions to run before and after the standard job build steps run. These are the same build steps offered as the build steps available in the free style job type.

In my experience, a release build typically requires pre-build steps of validating the project is releasable and bumping the version to the release version. After the build runs as usual, the post build steps are labeling the codebase and bumping the version to the next development version.

Executing a release

To run a release, click the Release icon from the job home page. This will bring you to the release details page where you will be prompted to fill in any parameters that you have defined (or the default RELEASE_VERSION and DEVELOPMENT_VERSION if there were no parameters defined).  As seen above, these values are then available at job execution time in both the pre and post release steps as well as the normal build steps. Finally, click the schedule release build and the job is scheduled to run immediately, now including the execution of the pre and post build steps.

Viewing results

Once the build is complete, the release plugin automatically locks the build, preventing it from being automatically deleted and adds a release icon denoting it as a release build.

Supported Job Types

 The release plugin supports the Maven2 and Free Style Job type

Recent Releases Portlet

The release plugin contributes a recent releases portlet that can be used in a Dashboard View

This portlet shows the 5 most recent release builds in normal mode with a link that brings you to the build page and the version string.
In the maximized mode, it shows the 50 most recent builds with additional detail.  Additionally it offers an rss feed while in the maximized mode so that you can get notified of all release builds or all failing release builds.

Version History

Version 2.5.3 (4/25/2015)

  • JENKINS-27722 upgrade to the release plugin has left the plugin broken (Pull request #12, thanks to glenritchie)
  • Change so that now you can select Publisher and Builders in the (release) build steps (Pull request #11, thanks to glenritchie)
  • Small translation fix (Pull request #10, thanks to Batmat)
  • Add two custom view job filters "All Release Jobs" and "Release Jobs" (Pull request #9, thanks to fritaly)
  • Define a new RELEASE permission (Pull request #8, thanks to fritaly)
    • BEWARE: You need to adapt your permissions so that users still see the release button
  • Set the description for the parent of a matrix build (Pull request #7, thanks to fritaly)
  • Add ability to run steps before/after all matrix configurations

Version 2.4.1 (9/27/2013)

  • Don't display release action in matrix configuration

Version 2.4 (8/04/2013)

Version 2.3 (9/20/2012)

  • JENKINS-13422 Added release button column
  • Use package.png instead of package.gif to have transparent icons
  • Fixed release link being shown when project was disabled

Version 2.2 (9/13/2011)

  • Disabled auto-refresh when triggering a new release (thanks rseguy)
  • JENKINS-9705 Option to override regular build parameters during release

Version 2.1 (3/13/2011)

  • JENKINS-8816 Wrapped each build steps list in a f:block which seems to correct the drag and drop behavior
  • JENKINS-8829 Create permalinks for the latest release and latest successful release builds
  • Added i8n for promotion support
  • Added German translations

Version 2.0 (2/15/2011)

  • Migrated to Jenkins
  • If release build result is not at least unstable, then don't keep build forever.
  • Expand release version template using build variables as well as release parameters
  • Add support for the promoted build plugin to add a condition that the build must be a release build
  • Show all previous release parameters when scheduling a release build
  • Add post successful build steps and post failed build steps
  • Prefill release parameters with previous release builds parameters (supports text field, checkbox & select list (drop-down list) input types)

Version 1.10 (7/21/2010)

  • Added new checkbox on job config page to allow the disabling of the automated marking of the build as keep forever
  • Fixed issue where if you had overlapping parameter names defined as release and build parameters, the default build parameter values were being used to resolve the release version template instead of the release parameter values.

Version 1.9 (11/15/2009)

  • Fixed issue where release plugin would prevent Jenkins from starting if dashboard view plugin was not installed (4845)
  • Fixed issue where recent releases portlet would throw NullPointer if a build was active

Version 1.8 (10/13/2009)

  • Added support for Dashboard View plugin by adding Recent Releases portlet

Version 1.7 (08/30/2009)

  •  After sleeping on it, changed the implementation to use the release version template so that parameters types don't have to be aware of the release plugin in order to be used as a release version string.

Version 1.6 (08/29/2009)

  • Added new Release String Parameter that, when configured as a release parameter, will be used as the release value and the plugin will then set description and tooltip. (4022)

Version 1.5 (08/06/2009)

  • Changed form submission to use post instead of get. File upload parameters work now.

Version 1.4 (05/16/2009)

  • Fixed regression issue introducing release parameters (3690)

Version 1.3 (05/11/2009)

  • Fixed regression due to maven plugin change (3628)

Version 1.2 (05/1/2009)

  • Added support for user supplied release parameters leveraging Jenkins' parameter capability (3370)

Version 1.1 (03/26/2009)

  • Add permissions on triggering a release
  • Fixed issue where parameters were not being resolved
  • Captured release parameters as build parameters which can now be viewed via build parameters link

Version 1.0 (02/10/2009)

  • Initial release 


plugin-buildwrapper plugin-buildwrapper Delete
supports-dashboard-view supports-dashboard-view Delete
plugin-listview-column plugin-listview-column Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment