Pre-Job Action Module

On this page:

Purpose of this Module Type

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 and BuildContext rather than just the BuildContext.

Configuration

The root element for the Pre-Job Action module is preJobAction. It allows the following attributes and child elements for configuration:

Attributes

Elements

The table summarises the elements. The sections below contain further information.

Interface

Pre-Job Action modules must implement the PreJobAction interface.

Example

Here is an example atlassian-plugin.xml file containing a Pre-Job Action module:

<atlassian-plugin name="Hello World" key="example.plugin.helloworld">
    <plugin-info>
        <description>A Pre-Job Action module type test</description>
        <vendor name="Atlassian Software Systems" url="http://www.atlassian.com"/>
        <version>1.0</version>
    </plugin-info>

    <preJobAction key="myPreJobAction" class="com.atlassian.example.bamboo.actions.MyPreJobAction">
        <description>Modifies the Job before it is queued</description>
    </preJobAction>
</atlassian-plugin>