This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Available:

Bamboo 2.7 and later

On this page:

Purpose of this Module Type

Post-Job Action modules allow plugins to define custom functionality that runs after all the results for Jobs belonging to the stage have been returned to the server and saved to the database.

Configuration

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

Attributes

Name

Required

Description

Default

class

(tick)

Unable to render {include} The included page could not be found.

 

key

(tick)

Unable to render {include} The included page could not be found.

N/A

name

 

Unable to render {include} The included page could not be found.
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

 

Unable to render {include} The included page could not be found.
Use this element to describe the section.

 

Interface

Post-Job Action modules must implement the PostJobAction interface.

Example

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

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

    <postJobAction key="myPostJobAction" class="com.atlassian.example.bamboo.actions.MyPostJobAction">
        <description>Tears down the Job once the result has been returned to the server and saved to the database</description>
    </postJobAction>
</atlassian-plugin>
  • No labels