Build Lifecycle Plugin Modules

These modules allow developers to extend Bamboos build processes with custom actions that change the outcome of the build, collect data, etc

Build Agent Requirement Filter Module

The Build Agent Requirement Filter module allows you to customise the list of Agents a plan can be built on. Bamboo will determine which agents meet the given requirement set, then send the list of agents through the filter for any further adjustments to the list.

Build Complete Action Module

Like the Build Processor Module, this allows you to specify a custom action to take place. However, the difference is that this will run after the full build result has been registered. The build is deemed to have completed before the BuildCompleteAction is fired. Hence, build complete actions cannot impact the state of the build.

Build Processor Module

The BuildProcessor module allows you to define a custom process that runs during the build.

Build Processor Server Module

The BuildProcessorServer module allows you to define a custom process that runs during the build.

Build Trigger Condition Module

The buildTriggerCondition http://docs.atlassian.com/atlassian-bamboo/3.0/com/atlassian/bamboo/build/BuildTriggerCondition.html module provides the ability to gate whether a build should be triggered or not. It uses a preference system so multiple trigger condition plugins can be used to determine the desired result. A build which fails the trigger condition will not be executed, there will be no trace of the existence of this build.

Command Decorator Module

Deprecated Since Bamboo 3.1 There is no replacement to this module, please contact atlassian https://support.atlassian.com/ if you were using this module.

Custom Build Definition Transformer Module

Post-Build Completed Action Module

Like the Build Processor Module, this allows you to specify a custom action to take place. However, the difference is that this will run after the full build result has been registered. The build is deemed to have been completed before the PostBuildCompletedAction is fired. Hence, build complete actions cannot impact the state of the build.

Post-Chain Action Module

Post-Chain Action modules allow plugins to define custom functionality that runs after the Plan finishes executing. This module will be run regardless of BuildState or LifeCycle state of the ChainResultsSummary http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/ChainResultsSummary.html (For example, if the build completed successfully or failed). The module provides access to the Chain http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/Chain.

Post-Job Action Module

Post-Job Action modules allow plugins to define custom functionality that runs after all the results for jobs https://confluence.atlassian.com/display/BAMBOO/Jobs+and+tasks belonging to the stage have been returned to the server and saved to the database.

Post-Stage Action Module

Post-Stage Action modules allow plugins to define custom functionality that runs after the jobs for the given stage have finished executing. The module provides access to the ChainResultsSummary http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/ChainResultsSummary.html, ChainStageResult http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/ChainStageResult.html (where by individual BuildResultsSummary http://docs.atlassian.com/atlassian-bamboo/

Pre-Build Action Module

The PreBuildAction module allows you to define a custom process that runs before your build begins.

Pre-Build Queued Action

Like the Build Processor Module, this allows you to specify a custom action to take place. However, the difference is that this will run before the build has been queued and the build made executable for both local and remote Bamboo agents. This is the first custom action that is run when a new Bamboo build is triggered, thus build state can be modified at this time.

Pre-Chain Action Module

Pre-Chain Action modules allow plugins to define custom functionality that runs before the Plan executes. The module provides access to the Chain http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/Chain.html object and the ChainExecution http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/ChainExecution.html.

Pre-Job Action Module

Pre-Job Action modules allow plugins to define custom functionality that runs on the server before the Job is queued. This module shares similarities but differs from the Pre-Build Queued Action because it gives access to both the StageExecution http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/StageExecution.html and BuildContext http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/v2/build/BuildContext.html rather than just the BuildContext http://

Pre-Stage Action Module

Pre-Stage Action modules allow plugins to define custom functionality that runs before the jobs for the given stage are queued for building. The module provides access to the StageExecution http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/StageExecution.html object.

Restart Failed Stage Action Module

Restart Failed Stage Action modules allow plugins to define custom functionality that runs before restarting failed stages. The module provides access to the StageExecution http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/StageExecution.html object.

Resume Manual Stage Action Module

Resume Manual Stage Action modules allow plugins to define custom functionality that runs before resuming manual stages. The module provides access to the StageExecution http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/StageExecution.html object.

Stop On Manual Stage Action Module

Stop On Manual Stage Action modules allow plugins to define custom functionality that runs after the Plan stops executing on manual stage. This module will be run only if build completed successfully. The module provides access to the Chain http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/Chain.html object, the ChainResultsSummary http://docs.atlassian.com/atlassian-bamboo/latest/com/atlassian/bamboo/chains/ChainResultsSummary.html and the ChainExecution http://docs.

Source Repository Module

A plugin module which defines a repository in Bamboo, such as CVS, Subversion, or Perforce.

Task Plugin Module

A task plugin represents a unit of work during a Build. Each Job can now have multiple Tasks which run in order on a single Agent. If a Task fails the following tasks will not execute, with the exception of Final Tasks which will always execute.

Trigger Reason Module

A plugin module which defines a trigger reason in bamboo. For example, DependencyTriggerReason, InitialbuildTriggerReason, ScheduledTriggerReason. You want to implement a trigger reason if you are kicking off a build for some reason other than those which are currently defined in Bamboo.

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport