PostBuildScript

PostBuildScript

Build Status Jenkins Plugins GitHub contributors

The PostBuildScript plugin allows you to run the following actions after a build:

  • Batch or shell scripts
  • Groovy scripts
  • Build steps

You can configure these actions depending on the build status (i.e., only run when build is successful). Scripts can also be executed on the master, on slaves or both. On matrix projects, the build can be executed on each axis.

User Interface

Please refer to the plugin description for further information.

Downloads

You'll find the latest HPI files of the plugin here:

http://updates.jenkins-ci.org/download/plugins/postbuildscript

Just put a HPI file into your plugins subdirectory of your Jenkins installation root, e.g. /var/lib/jenkins. Restart Jenkins afterwards.

Issue Tracking

Please use the official Jenkins Jira project and issue tracking software to report new bugs or request features.

Please first look through Jira. If a ticket already exists, please add a comment and try to explain the issue a little more further. If no ticket exists, please open a new one.

In general please provide example configurations (config.xml, Job DSL scripts, ...) and also screenshots are very helpful to reproduce problems.

Please try to be constructive. If you have a feedback, it's better to write me a direct message.

Pull Requests

For bug fixes and enhancements to existing features, first make sure an issue is filed by checking this Jira filter

After that please create a pull request on GitHub with your change and link to the JIRA issue in the PR, and link to the PR from the JIRA issue.

Release Notes

Version 3.3.0

  • Upgraded to Jenkins 2.452
  • Upgraded to JUnit 5

Version 3.2.0

Dependencies require Jenkins 2.359, so this will be the new base version for the PostBuildScript plugin.

Version 3.1.0

Updated Jenkins Plugin Parent to Version 4.32 to ensure, that no Log4j issues exist. Also updated Matrix Project dependency to 1.19, which requires at least Jenkins 2.282. Therefore switched to Jenkins version 2.289.

Version 3.0.0

I removed several deprecated configuration parts in this version. They were deprecated long time ago on very old versions. On https://stats.jenkins.io/plugin-installation-trend/postbuildscript.stats.json you can see, that most installations use version 2.11.0 of this plugin now. Most versions silently upgrade to a newer configuration, so I recommend to first upgrade minor versions and save your job configurations. For most users there won't be a problem, but users of very old plugin versions < 2.8.0 should first upgrade to at least 2.8.0 and save their job configurations.

Users of the Jenkins Job DSL should use the dynamic DSL and not the old manual implementation of the PostBuildScript publisher.

  • JENKINS-65797 Due to major changes in the job configuration, this plugin version is now based on Jenkins 2.277.1 and therefore requires a new Jenkins version. I also cannot guarantee, that old job configurations will work. Please mind potential broken configurations when upgrading and make sure, that you backed up your files. I recommend you to check your build jobs carefully.
  • Updates Jenkins Plugin Parent
  • Fix problem with script file path determination using Windows

Version 2.11.0

  • JENKINS-63529 - Allows configuring, whether to stop a post build step if any of its steps fails.

Version 2.10.0

  • Upgrade to parent POM version 4. It will at least support Jenkins 2.200

Version 2.9.1

  • JENKINS-57545 - Java 11 support

Version 2.8.1

  • JENKINS-53446 - Allows saving post-build script steps without actual build steps

Version 2.8.0

  • JENKINS-53691 - Implemented mechanism to migrate old matrix project post-build actions

Version 2.7.0

  • JENKINS-50799 - Skips script when flagged to run when failing

Version 2.6.0

Removed access to workspace on master for Groovy script execution, because secure groovy scripts cannot be configured on slaves when using a master-to-slave callable. Groovy scripts may not access files of the master's workspace as a result. However Groovy scripts can be run on slaves again. Thanks to John David for reporting this issue.

  • JENKINS-49952 - Groovy post-build script in matrix job throws exception

Version 2.5.1

If the shebang contains a space in front of the interpreter, it will be stripped out.

  • JENKINS-49681 - Scripts always fail when run in build, but succeed from command line

Version 2.5.0

This version introduces the ability to run Groovy scripts in a sandbox when activated using the checkbox in the configuration view.

Now you can also select for each script whether it should be executed on each axe or on the whole matrix.

  • JENKINS-48014 - Allow sandboxing for Groovy scripts
  • JENKINS-22489 - Add the ability to specify where each script executes instead of all of the scripts when added to a matrix job.

Version 2.4.0

The old option to build only on success or on failure will now be migrated differently: If both is not selected, the behavior of versions previous to 1.0.0 was to build it independent of the actual build result. Previous versions (after 1.0.0) simply migrate that to do nothing. With version 2.4.0 every build result will be selected in such cases.

  • JENKINS-49423 - Upgrade from 0.17 incomplete when scriptOnlyIfSuccess and scriptOnlyIfFailure are both false

Version 2.3.0

  • JENKINS-48931 - PostBuildScript Execute Script Execute Shell Textbox Formatting Broken

Version 2.2.1

Removing deprecated fields from configuration

Using default values for results and roles on newly created script items.

Version 2.2.0

Unified script file handling.

There are separate messages now, if a script is not run because the build result or the role does not fit.

Version 2.1.0

Dan Clayton added the BUILD_RESULT variable to allow handling script actions depending on the build result.

Version 2.0.0

Refactored the way, how script files are differentiated. This ensures extensibility and helps removing redundant code.

Also removed null pointer exception that occurs on executing a postbuild groovy script on an agent.

Version 1.1.1

Fixed some bugs that came in with the release of a new major version. Sorry for the inconvenience.

  • JENKINS-48197 - Do not initialize fields already loaded from configuration
  • JENKINS-48177 - Even marking build as unstable when errors during script execution appear
  • JENKINS-48169 - Using better descriptions for role limitations

Version 1.1.0

Attention: This is a major refactoring of the plugin. It hasn't been updated for years now. The configuration was changed, but your existing configuration will be automatically migrated to the new format. I cannot reproduce every configuration, so please open a bug ticket (and try to be kind, I'm doing this in my free time and don't want to harm anyone).

  • JENKINS-11285 - Ability to run postbuild script on a given node

Version 1.0.0

  • JENKINS-30011 - Allow multiple instances of Post Build Scripts as a post build action
  • Fix JENKINS-28825 - Confusing error message when leaving script path empty
  • Major refactoring, but still trying to be downwards compatible
  • Added help files and translations
  • JENKINS-24308 - Expost build variable, the AbstractBuild

Version 0.18

  • Fix JENKINS-43637 - Arbitrary code execution vulnerability: #15
  • Fix JENKINS-19873 - Batch or a shell script files to execute doesn't run with arguments

Version 0.17

  • Added an option to set the build to unstable instead of failed

Version 0.16

  • Fix JENKINS-16789 - Concurrent builds using postbuildscript plugin will wait for all the instances to finish

Version 0.15

  • Fix JENKINS-19954 - PostBuildScript runs for each matrix configuration rather than after they are all completed when set to MATRIX

Version 0.14

  • Fix JENKINS-19326 - Groovy script should execute with workspace dir as working directory.
  • Fix JENKINS-19072 - No Such Field: 'executeOnMatrixNodes'
  • Fix JENKINS-18936 - checkbox is not staying checked
  • Fix JENKINS-19033 - execution is always last, rather than where placed in the post-build actions list
  • Fix JENKINS-18530 - Postbuild script plugin not respecting order in Post-build Action

Version 0.13

  • Fix JENKINS-11219 - execution is always last, rather than where placed in the post-build actions list

Version 0.12

  • Let user configure script to be executed either on matrix head or axes nodes. Hidden for non-matrix projects

Version 0.11

  • Fix JENKINS-15395 - Add checkbox to run script when build fails (as well as when it passes)

Version 0.10

  • Fix JENKINS-14668 - failure to load without ivy plugin installed

Version 0.9

  • Merge pull request - Make dependency to Ivy plugin optional

Version 0.8

  • Fixed JENKINS-13418 - PostBuildScript plugin does not load its configuration properly
  • Change default value for condition to run scripts if the build is not on success.

Version 0.7

  • Fixed a bug where this plugin breaks Promoted Builds Plugin

Version 0.6

  • Added support of Ivy job type

Version 0.5

  • Built for 1.409 (LTS series)
  • Added an option to run this build scripts only on success (merge pull request)

Version 0.4

  • Fixed JENKINS-11219 - Add the option to run the script after all the sub elements of a matrix project build have finished

Version 0.3

  • Added job build steps to post-build actions

Version 0.2

  • Fixed JENKINS-10889 - PostBuildScript plugin fails with Maven2 jobs

Version 0.1

  • Initial Version