View Flexible Publish on the plugin site for more information.
- Use a publisher more than once within a build
- Select the execution order of the publishers
- Use Run Conditions to decide whether to publish
- Use Builders as actions by installing the Any Build Step Plugin (which will also install the Conditional BuildStep Plugin)
Always use Always
If you always add your Post-build Actions to Flexible publish, then not only will you be able to change the execution order afterwards, but you will have the ability to temporarily disable a publisher without losing the publishers' configuration.
You can just switch between the Always and the Never run conditions.
|There are no images attached to this page.|
This plugin can be installed from the Update Center (Manage Jenkins > Manage Plugins) under "Other Post-Build Actions".
To install manually, download the latest plugin from http://mirrors.jenkins-ci.org/plugins/flexible-publish/ and use the Upload Plugin option in the Advanced tab of the Plugin Manager.
If you do install manually, you will need to also install the Run Condition Plugin from http://mirrors.jenkins-ci.org/plugins/run-condition/ and the Token Macro Plugin from http://mirrors.jenkins-ci.org/plugins/token-macro/.
Import existing publishers
In Manage Jenkins/ Script console, copy the following to see which publishers can be moved (for a job named 'My Job')
Or, if you like doing it the hard way ...
You should see a list something like this
You can move a publisher into Flexible publish
After moving one or more publishers, go to the configure page, check everything looks ok, then save the configuration.
If you like to live on the edge, and would like to move all of the publishers in one go, then ...
Used with multi-configuration projects
When you use Flexible Publish Plugin with multi-configuration projects (aka. matrix projects), you should know followings:
Generally, publishers run in two phase for multi-configuration projects.
- Run for each combination of axes. It works just like in Free Style Projects.
- Run for whole the multi-configuration project. This is what is called aggregation.
For example, "Publish JUnit test result report" works:
- see test results in each combination of axes
- sum up the results of all of the combinations.
You can specify conditions both for each combination and the aggregation.
If you want to separate condition for them, check "Condition for Matrix Aggregation" (This appears only in multi-configuration projects).
This is especially useful for the case you want control the execution of the publisher depends on combination of axes.
Be careful to specify the condition, for inconsistent execution causes the build fails.
How flexible publish works when a publisher fails
- Available since flexible-publish-0.15.
- You can specify "Execution Strategy" with which flexible publish decides how to work when a publisher fails.
Behavior on a failure of a publisher
Fail at end
Continues to run following publishers. The default behavior in flexible-publish 0.15 and later.
Doesn't run following publishers. The default behavior for flexible-publish configured in 0.13 and 0.14.1.
- This works as followings:
- Example configuration
- When Publisher 1 fails, following publishers are handled as:
Execution Strategy for Condition 1
Fail at end
- Following conditions are always performed even prior publishers failed.
- Following publishers in a same condition is performed when the execution strategy is "Fail at end".
Some publishers may not work with Flexible Publish.
- Some publishers may not be prepared to run more than once during a build
- Some publishers need to find themselves configured in the projects, but fail to do that when included in Flexible Publish.
Known plugins that doesn't work with Flexible Publish
Causes NPE on execution
Tasks will be duplicated if a project contains multiple Post build task
Side links are duplicated
- Some publishers display side links in project status pages and build status pages.
- Configuring multiple publishers of a same kind results duplicated side links like this (this is a case with Email-ext plugin):
- There's no proper and general way to fix this, and this isn't planned to be fixed as it's harmless.
Known plugins that duplicates site links in project pages with Flexible Publish
Known plugins that duplicates site links in build pages with Flexible Publish
Why named "Flexible Publish" ?
- It's often accused that "Flexible Publish plugin should have been named Conditional Publisher plugin"
- You couldn't reorder publishers with old Jenkins (Jenkins < 1.463). Also see https://groups.google.com/forum/?fromgroups#!topic/jenkinsci-dev/UQLvxQclyb4
- A feature to reorder publishers was as important as a feature to launch publishers conditionally. So named "Flexible Publish".
0.15 (Mar 28, 2015)
- Introduced "Execution strategy" which controls the behavior when a publisher fails. (JENKINS-26936, JENKINS-27278)
- See #How flexible publish works when a publisher fails for details.
- The condition is evaluated only once when multiple actions in a condition (JENKINS-27171).
- Example Configutraion
- It was evaluated like this in flexible-publish 0.14.1
- flexible-publish 0.15 now evaluates as following
- If you really need conditions evaluated for each actions, please update the configuration like this:
0.14.1 (Jan 17, 2015)
This is a bug fix for 0.13.
This should be released as 0.13.1, but I mistook. Sorry.
- FIXED: NPE if no publisher in conditional step (JENKINS-26452)
0.13 (Nov 09, 2014)
- Supports multiple actions for a condition. (JENKINS-22187)
- Also work for Depende*n*cyDeclarer introduced in Jenkins 1.501. (JENKINS-25017)
- improved explanation for the aggregation condition. (JENKINS-21345)
- Fixed a wrong error message when failed to instantiate a publisher. (JENKINS-21497)
- Add support for upcoming $class annotation change (JENKINS-25403)
- Now support publishers with customized Descriptor#newInstance (JENKINS-19494, JENKINS-14454, JENKINS-14597, JENKINS-19257)
- Fixed JENKINS-13795 NPE when configuring Flexible publish in a new job
- Exclude "Trigger parametrized build on other projects" JENKINS-12418
- Mark the build as a failure if an action would have stopped the build
- Add some utility methods to allow publishers to be moved into Flexible publish from the script console
- Don't allow "Build other projects" in the Flexible publish - it does not work here
- Do not allow the actions to prevent other publishers from running (unless they throw an exception)
- Changed the EP interface
- Add extension to enable the list of publishers to be modified
- Updated a help file
- Enable the user to choose what will happen if the evaluation of a condition fails
- Initial release