This page last changed on Feb 02, 2009 by alui.

Integrating Bamboo with Atlassian's JIRA combines Bamboo's continuous integration capabilities with your issue tracker to give you a unified view of your software development project. Using JIRA and Bamboo together, you can see which issues are being actively coded, which builds have run for an issue, find the build that fixed the issue, download your distribution and much more.

What version of Bamboo and JIRA do I need?
Bamboo-JIRA integration requires the following software versions:
  • Bamboo 2.1 or later
  • JIRA 3.12 or later

The Bamboo plugin for JIRA has not been tested with versions of JIRA earlier than 3.12, but may work with earlier versions up to JIRA 3.7. However, we strongly advise you to upgrade JIRA to 3.12, if you wish to integrate Bamboo with JIRA.

Configuring Bamboo and JIRA to work together is a simple four step process:

  1. Download and install the bamboo-plugin jar in JIRA
  2. Configure the Bamboo plugin on the JIRA Server
  3. Allow remote API connections on The Bamboo Server
  4. Configure the JIRA plugin on the Bamboo Server

Before you begin

There are security considerations that you should take into account when integrating Bamboo with JIRA:

  • When you connect JIRA to Bamboo during the integration process below, you must specify a user that JIRA uses to log in to Bamboo (see '2. Configure the Bamboo plugin on the JIRA Server'). Please be aware that when JIRA accesses Bamboo, this user's Bamboo permissions will be used (not the Bamboo permissions of the user who is currently logged into JIRA). For example, a user viewing Bamboo information in JIRA will see all builds available to the user specified in the JIRA-Bamboo setup, instead of the builds available under their own permissions.
  • Similarly, when you connect Bamboo to JIRA during the integration process below, you must specify a user that Bamboo uses to log in to JIRA (see '4. Configure the JIRA plugin on the Bamboo Server'). Please be aware that when Bamboo accesses JIRA, this user's JIRA permissions will be used (not the JIRA permissions of the user who is currently logged into Bamboo). For example, a user viewing JIRA information in Bamboo will see all issues available to the user specified in the Bamboo-JIRA setup, instead of the issues available under their own permissions.

To prevent information in JIRA and Bamboo being unintentionally displayed to the wrong users, please ensure that you specify a user with appropriate permissions when connecting JIRA to Bamboo and vice versa.

1. Download and install the bamboo-plugin JAR in JIRA

The Bamboo Plugin for JIRA is shipped with JIRA, from JIRA 3.13.2 onwards. Hence, if you are using JIRA 3.13.2 or later, you can skip this step. However, if you are using a version of JIRA prior to 3.13.2, you will need to download and install the plugin manually, as described below.
To set up the Bamboo plugin,

  1. Download the latest bamboo-plugin JAR file (e.g. jira-bamboo-plugin-1.0.2.jar) from the Bamboo plugin for JIRA home page.
  2. Copy the JAR file to the WEB-INF/lib folder inside your JIRA web application, remember to first delete old versions of the JAR files if they exist.
  3. Restart JIRA.

2. Configure the Bamboo plugin on the JIRA Server

Once you have set up the Bamboo Plugin for JIRA in your JIRA instance, the next step is to tell JIRA where to find your Bamboo server.
To configure your Bamboo plugin,

To configure your Bamboo plugin:

  1. Launch your JIRA instance, if it is not already running.
  2. In the JIRA 'Administration' screen, go to 'Global Settings' and select the 'Bamboo Server' link.
  3. Enter the folllowing fields:
    • Server name - The name of your Bamboo server
    • Host - The URL of your Bamboo instance eg http://localhost:8085/bamboo/
    • User name - The user name that JIRA will use to login to Bamboo
    • Password - The password for the user specified above
      Currently you can only specify one Bamboo server per JIRA installation.
  4. You will also need to allow remote API access by enabling the 'Allow remote API access' option, as described in that JIRA documentation.
Managing access to Bamboo information in JIRA
Access to Bamboo information in JIRA (i.e. builds information related to issues, versions and projects) is managed by the 'View Version Control' project permission in JIRA. If you have not added this permission to your JIRA project, you will not be able to view any Bamboo information for that project. Read the JIRA documentation on project permissions for instructions on how to add this permission.
Non-standard JIRA issue keys
Please note, that you cannot change the JIRA issue key format from the standard configuration, if you wish to integrate JIRA with Bamboo. See BAM-3492 for further details.

3. Allow remote API connections on the Bamboo Server

Now that you have set up JIRA to point at your Bamboo server correctly, you will need to allow external programs (i.e. JIRA) to access Bamboo's data externally.
To allow remote access to Bamboo's data,

  1. To allow remote access to Bamboo's data, you need to enable Bamboo's remote REST-style API by following these instructions: Enabling Bamboo's Remote API
    Please note that remote access to Bamboo data is disabled by default.

You should now be able view information on your builds in your JIRA instance (e.g. view the related builds on a particular issue). To complete the integration of Bamboo with JIRA, the JIRA Plugin for Bamboo in your instance of Bamboo needs to be configured so that you can view JIRA information in Bamboo.

4. Configure the JIRA plugin on the Bamboo Server

The JIRA Plugin for Bamboo is shipped with Bamboo, so you do not need to download and install it. You simply need to tell Bamboo where to find your JIRA instance and provide it with the necessary authentication details.
To enable the JIRA integration plugin,

  1. Launch your Bamboo instance, if it is not already running.
  2. Click the 'Administration' link in the top navigation bar.
  3. Click the 'JIRA Server' link in the left navigation column.
  4. In the 'Host URL' field, type the URL address of your JIRA server (e.g. 'http://jira.atlassian.com').
  5. In the 'Username' field, type the name of the JIRA account which your Bamboo server will use to login to your JIRA server.
    This JIRA account does not require JIRA administration permission.
  6. In the 'Password' field, type the corresponding password for the JIRA account you specified in step 4.
  7. (Only perform steps 6 and 7 if you are running JIRA 3.7 or later)  In the 'Test' section, type a JIRA issue key in the 'Issue Key' field (e.g. 'BAM-738').
  8. Click the 'Test' button. This should display the following message: 'Successfully retrieved JIRA issue from remote server'. If not, check that you can login to your JIRA server using the JIRA account and password you specified in steps 4 and 5.
  9. When the test is successful, click the 'Save' button.

Congratulations! You have successfully integrated Bamboo and JIRA. You may wish to read about how to use these two applications together in the following pages:

Need help?

If you need further help, please raise a support request in our support system, in the Bamboo project.

Document generated by Confluence on Mar 02, 2009 18:51