| Name | Bamboo Plugin |
|---|---|
| Vendor | Atlassian (Website) |
| Authors | Cheryl Jerozal |
| Homepage | http://confluence.atlassian.com/display/CONFEXT/Bamboo+Plugin |
| Issue Management | http://developer.atlassian.com/jira/browse/CBAM |
| Categories | Content Macros |
| Version | 0.3 |
| Availability | Confluence v2.6.0 to v2.9-m5 |
| State | Beta |
| Support |
|
| License | Freeware / Open Source (BSD) |
| Price | Free |
| Release Docs | http://confluence.atlassian.com/display/CONFEXT/Bamboo+Plugin |
| Java API Docs | n/a |
| Download Source | http://svn.atlassian.com/svn/public/contrib/confluence/bamboo-plugin/tags/confluence-bamboo-plugin-0.3/ |
| Download JAR | confluence-bamboo-plugin-0.3.jar |
Description/Features
The Confluence Bamboo plugin provides several macros that allow Confluence users to easily display data from Bamboo, such as the status of a particular plan's latest build.
 | Compatibility Note This plugin is not compatible with Bamboo versions 1.2.x and below because it uses additions to the Bamboo REST API that were made in Bamboo 2.0. |
Installation
Upload this plugin using the Plugin Manager or the Confluence Repository Client.
Configuring your Bamboo server(s)
You must tell the plugin about any Bamboo servers you want it to be able to retrieve data from. Managing Bamboo servers is done from the Bamboo plugin's configure screen, which can be reached by going to Administration - Plugins - Bamboo Plugin - Configure plugin.
Each server should have a key, and the key is what users will specify to identify which Bamboo server to get data from when displaying a particular macro. If there is a default server configured, then that will be used to display macros when no server parameter is given.
(Note that Bamboo servers you want to get data from with the plugin must have remote API calls enabled.)
Usage
{current-build}
This macro prints the status of the latest build of a Bamboo plan.
| Parameter | Description | Allowed values | Default value | Required |
|---|---|---|---|---|
| server | allows you to specify which Bamboo server to use | one of the servers configured in the Bamboo plugin configuration screen | key of default server, if one is configured | yes, if default server is not configured |
| plan / (default) | the key of the build plan, e.g. "CONFSTABFUNC-LDAP" | any valid plan key from the Bamboo server being used | none | yes |
| mode | allows you to specify how to display the build results | compact - prints an icon to indicate whether the build has passed or failed. inline - prints whether the build has passed or failed. full - prints some info about the latest build, including whether it passed or failed |
inline | no |
| width | display width - only meaningful when using mode=full | an integer number of pixels followed by "px", or a percentage width followed by "%" | 100% | no |
Examples
{current-build:CONFSTABFUNC-LDAP} (when failing)
{current-build:plan=CONFSTABFUNC-LDAP|mode=inline} (when succeeding)
{current-build:CONFSTABFUNC-LDAP|mode=compact} (when failing)
{current-build:CONFSTABFUNC-LDAP|mode=full}
{recent-builds}
This macro prints the most recent Bamboo builds from a plan, by a author, or in a project.
| Parameter | Description | Allowed values | Default value | Required |
|---|---|---|---|---|
| server | allows you to specify which Bamboo server to use | one of the servers configured in the Bamboo plugin configuration screen | key of default server, if one is configured | yes, if default server is not configured |
| plan / (default) | the key of the build plan, e.g. "CONFSTABFUNC-LDAP" | any valid plan key from the Bamboo server being used | none | one of plan, author, or project is required |
| author | the username of the author to print recent builds from | any valid author username from the Bamboo server being used | none | one of plan, author, or project is required |
| project | the key of the project to print recent builds from, e.g. "CONFSTABFUNC" | any valid project key from the Bamboo server being used | none | one of plan, author, or project is required |
| width | display width | an integer number of pixels followed by "px", or a percentage width followed by "%" | 100% | no |
Examples
{recent-builds:CONFSTABFUNC-LDAP}
{recent-builds:project=CONFSTABFUNC}
{recent-builds:author=mjensen}
{bamboo-project}
This macro prints the latest status of all builds in a Bamboo project.
| Parameter | Description | Allowed values | Default value | Required |
|---|---|---|---|---|
| server | allows you to specify which Bamboo server to use | one of the servers configured in the Bamboo plugin configuration screen | key of default server, if one is configured | yes, if default server is not configured |
| project / (default) | the key of the project, e.g. "CONFSTABFUNC" | any valid project key from the Bamboo server being used | none | yes |
| width | display width | an integer number of pixels followed by "px", or a percentage width followed by "%" | 100% | no |
Examples
{bamboo-project:CONFSTABFUNC}
{bamboo-chart}
This macro prints various Bamboo charts.
| Parameter | Description | Allowed values | Default value | Required |
|---|---|---|---|---|
| server | allows you to specify which Bamboo server to use | one of the servers configured in the Bamboo plugin configuration screen | key of default server, if one is configured | yes, if default server is not configured |
| plan / (default) | the key of the build plan, e.g. "CONFSTABFUNC-LDAP" | any valid plan key from the Bamboo server being used | none | yes |
| type | allows you to specify the chart type | NUMBER_OF_FAILURES - shows the number of failures and accompanying duration charts PERCENT_SUCCESS - shows the percent failures and accompanying duration charts |
NUMBER_OF_FAILURES | no |
| builds | allows you to specify the set of builds to include | LAST_25_BUILDS LAST_7_DAYS LAST_30_DAYS LAST_90_DAYS ALL_BUILDS |
LAST_25_BUILDS | no |
Examples
{bamboo-chart:CONFSTABFUNC-LDAP|type=NUMBER_OF_FAILURES}
{bamboo-chart:CONFSTABFUNC-LDAP|builds=LAST_7_DAYS}
{bamboo-chart:CONFSTABFUNC-LDAP|type=PERCENT_SUCCESS}
Version History
| Version | Date | State | License | Price |
0.3
(#4)
|
01 May 2008 | Beta | Freeware / Open Source (BSD) | Free |
|
0.2
(#3)
|
01 Apr 2008 | Beta | Freeware / Open Source (BSD) | Free |
|
0.1.1
(#2)
|
13 Dec 2007 | Beta | Freeware / Open Source (BSD) | Free |
|
0.1
(#1)
|
12 Dec 2007 | Beta | Freeware / Open Source (BSD) | Free |