Post-Stage Action Module

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 the 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

Elements

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

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>