Post-Chain Action Module

On this page:

Purpose of this Module Type

Post-Chain Action modules allow plugins to define custom functionality that runs after the Plan finishes executing. This module will be run regardless of BuildState or LifeCycle state of the ChainResultsSummary (For example, if the build completed successfully or failed). The module provides access to the Chain object, the ChainResultsSummary and the ChainExecution.

Configuration

The root element for the Pre-Chain Action module is postChainAction. 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-Chain Action modules must implement the PostChainAction interface.

Example

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

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

    <postChainAction key="myPostChainAction" class="com.atlassian.example.bamboo.actions.MyPostChainAction">
        <description>Tears down and saves data for MyBambooPlugin if the Chain has the plugin enabled</description>
    </postChainAction>
</atlassian-plugin>