Promoted Builds Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID promoted-builds Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
2.17
Mar 05, 2014
1.448
maven-plugin (version:1.448)
javadoc (version:1.0)
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
Kohsuke Kawaguchi (id: kohsuke)
Peter Hayes (id: petehayes)
Usage Installations 2013-Apr 3914
2013-May 4017
2013-Jun 4125
2013-Jul 4309
2013-Aug 4302
2013-Sep 4501
2013-Oct 4770
2013-Nov 4837
2013-Dec 4760
2014-Jan 5109
2014-Feb 5328
2014-Mar 5559

This plugin allows you to distinguish good builds from bad builds by introducing the notion of 'promotion'.Put simply, a promoted build is a successful build that passed additional criteria (such as more comprehensive tests that are set up as downstream jobs.) The typical situation in which you use promotion is where you have multiple 'test' jobs hooked up as downstream jobs of a 'build' job. You'll then configure the build job so that the build gets promoted when all the test jobs passed successfully. This allows you to keep the build job run fast (so that developers get faster feedback when a build fails), and you can still distinguish builds that are good from builds that compiled but had runtime problems.

Another variation of this usage is to manually promote builds (based on instinct or something else that runs outside Jenkins.) Promoted builds will get a star in the build history view, and it can be then picked up by other teams, deployed to the staging area, etc., as those builds have passed additional quality criteria. In more complicated scenarios, one can set up multiple levels of promotions. This fits nicely in an environment where there are multiple stages of testings (for example, QA testing, acceptance testing, staging, and production.)

Promotion Action

When a build is promoted, you can have Jenkins perform some actions (such as running a shell script, triggering other jobs, etc. — or in Jenkins lingo, you can run build steps.) This is useful for example to copy the promoted build to somewhere else, deploy it to your QA server. You can also define it as a separate job and then have the promotion action trigger that job.

Do not rely on files in the workspace
The promotion action uses the workspace of the job as the current directory (and as such the execution of the promotion action is mutually exclusive from any on-going builds of the job.) But by the time promotion runs, this workspace can contain files from builds that are totally unrelated from the build being promoted.

To access the artifacts, use the Copy Artifact Plugin and choose the permalink.

Usage

To use this plugin, look for the "Promote builds when..." checkbox, on the Job-configuration page. Define one or a series of promotion processes for the job.

How might you use promoted builds in your environment? Here are a few use cases.

Artifact storage -- you may not want to push an artifact to your main artifact repository on each build. With build promotions, you can push only when an artifact meets certain criteria. For example, you might want to push it only after an integration test is run.

Manual Promotions - You can choose a group of people who can run a promotion manually. This gives a way of having a "sign off" within the build system. For example, a developer might validate a build and approve it for QA testing only when a work product is completed entirely. Then another promotion can be added for the QA hand off to production.

Aggregation of artifacts - If you have a software release that consists of several not directly related artifacts that are in separate jobs, you might want to aggregate all the artifacts of a proven quality to a distribution location. To do this, you can create a new job, adding a "Copy artifacts from another job" (available through Copy Artifact plugin") for each item you want to aggregate. To get a certain promotion, select "Use permalink" in the copy artifact step, then your promoted build should show up in the list of items to copy.

Notes

On Downstream Promotion Conditions

One of the possible criteria for promoting a build is "When the following downstream projects build successfully", which basically says if all the specified jobs successfully built (say build BD of job JD), the build in the upstream will be promoted (say build BU of job JU.)

This mechanism crucially relies on a "link" between BD and BU, for BU isn't always the last successful build. We say "BD qualifies BU" if there's this link, and the qualification is established by one of the following means:

  1. If BD records fingerprints and one of the fingerprints match some files that are produced by BU (which is determined from the fingerprint records of BU), then BD qualifies BU. Intuitively speaking, this indicates that BD uses artifacts from BU, and thus BD helped verify BU's quality.
  2. If BU triggers BD through a build trigger, then BD qualifies BU. This is somewhat weak and potentially incorrect, as there's no machine-readable guarantee that BD actually used anything from BU, but nonetheless this condition is considered as qualification for those who don't configure fingerprints.

Note that in the case #1 above, JU and JD doesn't necessarily have to have any triggering relationship. All it takes is for BD to use some fingerprinted artifacts from BU, and records those fingerprints in BD. It doesn't matter how those artifacts are retrieved either — it could be via Copy Artifact Plugin, it could be through a maven repository, etc. This also means that you can have a single test job (perhaps parameterized), that can promote a large number of different upstream jobs.

Available Environment Variables

The following environment variables are added for use in scripts, etc. These were retrieved from github here.

  • PROMOTED_URL - URL of the job being promoted
  • PROMOTED_JOB_NAME - Promoted job name
    • ex: job_name_being_promoted
  • PROMOTED_NUMBER - Build number of the promoted job
    • ex: 77
  • PROMOTED_ID - ID of the build being promoted
    • ex: 2012-04-12_17-13-03
  • PROMOTED_USER_NAME - the user who triggered the promotion
  • PROMOTED_JOB_FULL_NAME - the full name of the promoted job

Changelog

Version 2.17 (Mar 5, 2014)
  • Repeating/Duplicating promotion parameters (issue #22005)
Version 2.16 (Mar 5, 2014)
  • Added PROMOTED_USER_NAME environment variable (issue #16063)
  • Fixed a couple of typos
  • Fixed repeated exception being thrown when installed with literate plugin.
Version 2.15 (Jan 28, 2014)
  • Fixed NPE when no Manual Promotion was configured (issue #20166
Version 2.14
  • Enable editing parameters for re-executions (issue #8962)
Version 2.13
  • Added PROMOTED_JOB_FULL_NAME environment variable (issue #18958)
Version 2.12 (Aug 20, 2013)
  • Expose promotion information via the REST API
  • Prevent duplication of promotion processes when creating promotion processes from other plugins
Version 2.11 (Jun 09, 2013)
  • Fix for an NPE, and diagnosis for another.
  • Reduced plugin size by eliminating unnecessarily bundled library.
Version 2.10 (Mar 30, 2013)
  • NPE when used in 1.507+ (issue #17341)
  • Test failures, and possibly visible bugs, when used with recent Jenkins (issue #15156)
Version 2.9 (Mar 25, 2013)
  • New promoted build parameter that can be used to select builds that have been promoted
  • Fixed file parameter on ManualApproval not correctly uploading the file
Version 2.8 (Oct 30, 2012)
  • Build shouldn't be promoted by a deleted promotion process (issue #12799)
  • Honor annotated console output (issue #15328)
Version 2.7 (Sep 26, 2012)
  • Added a trigger that allows projects to listen to promotions happening in other projects
  • PROMOTE permission can be used in project matrix-based security (issue #14890)
  • Downstream jobs textbox is now auto-complete-capable (issue #14560)
Version 2.6.2 (Aug 6, 2012)
  • Fix manual promotion of maven project and matrix project (issue #13631, issue #13472)
  • Fix 404 when clicking the promotion's progress bar to view console output (pull-20)
Version 2.6.1 (Jul 2, 2012)
  • Fix preventing setting "Restrict where this project can be run" (issue #14197)
Version 2.6 (Jun 21, 2012)
Version 2.5 (Apr 12, 2012)
  • Improved hierarchical project support
Version 2.4 (Nov 3, 2011)
  • Fixed a possible NPE that fails the promotion (issue #11609)
  • Added Promotion History per Promotion Process at Project's Promotion Status page (issue #10448)
Version 2.3.1 (Oct 14, 2011)
  • Don't run promotionProcess that are disabled (issue #10423)
  • Manual approvement causes an NPE if project name or promotion name contains URI-unsafe chars (issue #11122)
Version 2.3 (Aug 9, 2011)
  • Modified the self-promotion condition so that it does not trigger for builds which are a failure. Also it is now configurable whether to self-promote for unstable builds. (issue #10250)
Version 2.2 (Jul 8, 2011)
  • Added a new promotion condition that immediately promotes itself.
Version 2.1 (May 4, 2011)
  • failed to Re-execute promotion if promotion builds plugin is disabled (issue #9588).
  • promote plugin should provide ability to select slave node to run (issue #9260).
  • Fix for NPE when promoting a build with a custom workspace (issue #9254).
  • Fixed a problem where removing a promotion process leaves broken image links in the build history.
  • Fixed a problem where deleting and recreating the promotion process with different case (abc vs ABC) can result in weird behavior on Windows.
Version 2.0 (Mar 5 2011)
  • If a promotion criteria is met but the promotion fails, change the icon to represent that.
  • Exposed the job name and the build number of the promotion target to the promotion process (PROMOTED_JOB_NAME and PROMOTED_NUMBER.)
  • If the build is parameterized, expose that to the promotion process as well
  • Added a new promotion criteria where a promotion in upstream promotes a downstream build.
  • Fully implemented manual approval with user / group permissions and display Approve button on promotion page (no longer need to allow force promotion to all)
  • New promotion action to mark the promoted build as keep forever
Version 1.11 (Jan 31 2011)
  • Promote a build even if downstream build is unstable. (issue #8626)
  • Promote Builds Plugin can use custom workspace. (issue #8547)
  • Invalid characters in Promotion name causes error. (issue #7972)
  • Fix promotion permlinks. (issue #8367)
  • Allow promotion actions to be reordered. (issue #8548)
Version 1.10 (Sep 28 2010)
  • Promotion processes are now recognized as permalinks.
Version 1.9 (Jun 9 2010)
  • If fingerprints are not available, use the upstream/downstream triggering information to determine the relationship as a fallback.
Version 1.8 (Jun 5 2010)
  • Add the possibility to choose a different color for the star icon, to be able to differenciate the various promotion processes
Version 1.7 (Mar 29 2010)
  • Use JDK configured for project when running promotions (issue #3526)
  • Select node for running promotions from label configured for project (issue #4089) (does not yet run on exact node where promoted build ran, unless project is tied to a single node)
  • Show most-recent first in promotion history tables (issue #6073)
Version 1.6 (Dec 30 2009)
Version 1.5 (Aug 17 2009)
  • Updated to work with Jenkins 1.320
Version 1.4 (May 21 2009)
  • Re-doing a release as 1.3 had never shown up in the update center.
Version 1.3 (May 11 2009)
  • Expose environment variable 'PROMOTED_URL' that points to the URL of the build that's being promoted (report)
  • Internal modernization.
Version 1.2 (Mar 25 2009)
  • Updated to work with the current Jenkins
Version 1.1 (Feb 20 2009)
  • Fixed a problem where Jenkins may issue the same warning multiple times for the same configuration problem (report)
  • SVN Tagging is now a permitted promotion step
  • Promotion now fails if any actions are not performed (issue #2597)
  • Improved logging of promotion build process so users can see what succeeded and what failed
  • Promotion action to build another project no longer does nothing (issue #1765)
  • Added "Promotion History" pane to the PromotedBuildAction page (issue #2794)
  • Fixed 404 for last failed link while promotion build occuring (issue #2578)PROMOTED_URL

Labels

Edit
plugin-misc plugin-misc Delete
plugin-ui plugin-ui Delete
plugin-builder plugin-builder Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment