Build Processor Module

Available:

Bamboo 1.0 and later

On this page:

Description

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

This will occur immediately after the builder has completed execution and the test results have been captured. The BuildProcessor forms part of build execution run and the result of the execution is only registered after your custom BuildProcessor has completed. This means that your plugin has the capability to affect the the final BuildState of your build (i.e. success/failure).

Bamboo has two different build processors, this one and the BuildProcessorServer.
The BuildProcessor runs on the agent and has full access to the file system (but no access to many of the Bamboo managers and the database).
The BuildProcessorServer, on the other hand, runs on the server side after a build has returned from the agent.

If you're writing a plugin that will only ever be run in a non-distributed environment, you can use either plugin points.

Interface

Build Processor modules must implement the CustomBuildProcessor interface.

Sample Module Descriptor Element

<buildProcessor key="cloverResultCollector" name="Clover Results Collector"
           class="com.atlassian.bamboo.builder.coverage.CloverBuildProcessor">
    <skipIfFailed>true</skipIfFailed>
    <resource type="freemarker" name="edit" location="templates/plugins/buildProcessor/cloverProcessorEdit.ftl"/>
    <resource type="freemarker" name="view" location="templates/plugins/buildProcessor/cloverProcessorView.ftl"/>
    <description>A Clover report parser and data collector</description>
  </buildProcessor>
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport