Post-Stage Action Module

Available:

Bamboo 2.7 and later

On this page:

Purpose of this Module Type

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, ChainStageResult (where by individual BuildResultsSummary objects for each job can be accessed) and the StageExecution.

Configuration

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

Attributes

Name

Description

class

The class which implements this plugin module. The class you need to provide depends on the module type. For example, Confluence theme, layout and colour-scheme modules can use classes already provided in Confluence. So you can write a theme-plugin without any Java code. But for macro and listener modules you need to write your own implementing class and include it in your plugin. See the plugin framework guide to creating plugin module instances.

key

The unique identifier of the plugin module. You refer to this key to use the resource from other contexts in your plugin, such as from the plugin Java code or JavaScript resources.

<component-import key="appProps" interface="com.atlassian.sal.api.ApplicationProperties"/>

In the example, appProps is the key for this particular module declaration, for component-import, in this case.

name

The human-readable name of the plugin module.

Only used in the plugin's administrative user interface.

*class and key attributes are required.

Elements

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

Name

Description

description

The description of the plugin module. The 'key' attribute can be specified to declare a localisation key for the value instead of text in the element body.

Use this element to describe the section.

Interface

Post-Stage Action modules must implement the PostStageAction interface.

Example

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

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

    <postStageAction key="myPostStageAction" class="com.atlassian.example.bamboo.actions.MyPostStageAction">
        <description>Tears down the stage after execution has completed</description>
    </postStageAction>
</atlassian-plugin>
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport