View Source

Available:	Bamboo 2.7 and later

On this page:

Purpose of this Module Type

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 object.

Configuration

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

Attributes

Name	Description	Default
class
key		N/A
name	Only used in the plugin's administrative user interface.

Elements

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

Name	Required	Description	Default
description		Use this element to describe the section.

Interface

Pre-Stage Action modules must implement the PreStageAction interface.

Example

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

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

    <preStageAction key="myPreStageAction" class="com.atlassian.example.bamboo.actions.MyPreStageAction">
        <description>Prepares the stage for execution</description>
    </preStageAction>
</atlassian-plugin>