Bamboo Plugin Module Types

The following types of plugin modules are supported by Bamboo:

Build Lifecycle Plugin Modules

Module Type

Plugin Framework Version

Since Bamboo version...

Documentation

Description

buildAgentRequirementFilter

1.x, 2.x

2.2

Build Agent Requirement Filter Module

Customises the list of Agents a plan can be built on.

buildCompleteAction

1.x, 2.x

1.0

Build Complete Action Module

Add a custom asynchronous action after the build process has completed.

buildProcessor

1.x

1.0

Build Processor Module

Append a custom synchronous process to the build. Occurs on the Agent (both local and remote) after the builder has run.

buildProcessorServer

1.x

2.0

Build Processor Server Module

Append a custom synchronous process to the build. Occurs on the Server after the build has been returned by the Agent.

command decorator

1.x

2.3 to 3.1

Command Decorator Module

Allows additional parameters to be added to the command line of a builder before a build occurs.

preBuildQueuedAction

1.x, 2.x

2.1

Pre-Build Queued Action

Prepends a custom synchronous process to the build. Occurs before a build is queued.

preBuildAction

1.x

1.1

Pre-Build Action Module

Prepends a custom synchronous process to the build. Occurs before the builder has run.

postBuildCompletedAction

2.x

2.6

Post-Build Completed Action Module

Add a custom asynchronous 'build context'-aware action after the build process has completed and the build results have been saved.

preChainAction

1.x, 2.x

2.7

Pre-Chain Action Module

Prepends a custom synchronous process before the chain starts executing

postChainAction

1.x, 2.x

2.7

Post-Chain Action Module

Prepends a custom synchronous process after the chain finishes executing

preStageAction

1.x, 2.x

2.7

Pre-Stage Action Module

Prepends a custom synchronous process before the stage starts executing

postStageAction

1.x, 2.x

2.7

Post-Stage Action Module

Prepends a custom synchronous process after the stage finishes executing

preJobAction

1.x, 2.x

2.7

Pre-Job Action Module

Prepends a custom synchronous process before the job starts executing

postJobAction

1.x, 2.x

2.7

Post-Job Action Module

Prepends a custom synchronous process after the job finishes executing

repository

1.x

1.1

Source Repository Module

Add a custom source repository.

taskType

1.x

3.1

Task Plugin Module

Add new Tasks to Bamboo

triggerReason

1.x

2.0

Trigger Reason Module

Add a new trigger reason.

Notification Plugin Modules

Module Type

Plugin Framework Version

Since Bamboo version...

Documentation

Description

notification-condition

1.x, 2.x

1.1 to 2.2

Notification Condition Module

Add new notification condition.

notificationType

1.x, 2.x

2.2

Notification Type Module

Add a new notification type

notificationRecipient

1.x, 2.x

2.2

Notification Recipient Module

Add a new notification recipient type.

Bamboo Event Listeners

Module Type

Plugin Framework Version

Since Bamboo version...

Documentation

Description

bambooEventListener

1.x, 2.x

2.2

Bamboo Event Listeners

Register an event listener against any Bamboo Events.

User Interface Plugin Modules

Module Type

Plugin Framework Version

Since Bamboo version...

Documentation

Description

additionalBuildConfigurationPlugin

1.x, 2.x

2.7

Additional Build Configuration Module

Register additional configuration UI on the Miscellaneous tab of the Configuration of a Job or Plan

report

2.x

1.0

Report Module

Defines a report of build telemetry data.

web-item

1.x, 2.x

1.0

Web Item Module

Add new links to the Bamboo interface.

web-section

1.x, 2.x

1.0

Web Section Module

Add a new section to the Bamboo interface.

web resource

1.x, 2.x

2.3

Web Resources

Permits web resources to be included with a plugin.

webRepositoryViewer

1.x, 2.x

2.5

Web Repository Viewer Module

Renders commit information to include web repository links and information.

xwork

1.x, 2.x

1.0

XWork Plugin Module

XWork actions and views bundled with the plugin. This enables building generic user interfaces.

System Plugin Modules

Module Type

Plugin Framework Version

Since Bamboo version...

Documentation

Description

capabilityTypeModule

1.x, 2.x

2.7

Capability Type Module

The Capability Type Module is used for registering custom capabilities

component

1.x

2.6

Component Module

Enables you to add components to Bamboo's internal component system (powered by Spring).

downloadable resource

1.x, 2.x

2.3

Downloadable Plugin Resources

Permits downloadable resources to be included with a plugin.

indexReader

1.x, 2.x

1.0

Index Reader Module

Reads out custom index information written by the postBuildIndexWriter from the index.

postBuildIndexWriter

1.x, 2.x

1.0

Post Build Index Writer Module

Writes custom build data into the index for report generation.

postChainIndexWriter

1.x, 2.x

2.7

Post Chain Index Writer Module

Writes custom chain data into the index for report generation.

Other Plugin Modules

Module Type

Plugin Framework Version

Since Bamboo version...

Documentation

Description

quickFilterRuleType

2.x

5.12.0

Quick Filter Rule Type Module

Custom type of rule used within Bamboo quick filters.

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport