Buildkite for Jira

Real-time Buildkite build status in Jira.

Getting Started

To begin, add a webhook notification in your Buildkite organisation.

Step 1: In the Buildkite organisation settings, head to ‘Notification Services’ & add a ‘Webhook’ notification:

Step 2: In the ‘Webhook URL’ field, fill in the URL found in the app’s ‘Get Started’ page in your Jira instance. Each URL is unique to each instance.

Step 2a: To make deployment information available in Jira as well, fill in the URL found in the app’s ‘Get Started’ page under Step 2a in your Jira instance. Each URL is unique to each instance.

By default, deployments will show up in Jira as ‘Undefined environment’ or ‘Others’. Jira supports 4 deployment environments: ‘development’, ‘testing’, ‘staging’ and ‘production’.

You can specify which environment to tag the deployment with by adding a ‘env’ query string to the webhook URL.

For example: Adding ‘?env=staging’ behind the webhook URL will tag the deployment under the staging environment.

Step 3: Enable all build events, including ‘scheduled’, ‘running’, ‘finished’ and ‘blocked’. Then, save the notification.

Step 4: Run builds & see build status show up.

Example Usage

Use this app to:

…get quick status of builds:

…get details of builds (build numbers come from Buildkite):

…get build status of Jira issues in a release:

…get quick status of deployments:

…get details of deployments:

…leverage upon Jira’s Deployment view:

Frequently Asked Question (FAQ)

1. Why can’t I see any builds in Jira?

   There are a few reasons for this:

   • The description from Buildkite exceeded 255 characters. While we do our best to truncate it before sending it to Jira API, there are other inputs such as emojis which will go beyond the limited character length.
   • Buildkite for Jira is now a paid app. Please update to the latest version available on Atlassian Marketplace to continue usage of the app.

2. Why does the development panel showing failed builds and not the latest build?

   Unfortunately this is controlled by Atlassian. In their documentation for development panel, a red status lozenge will show “if at least one run failed for any build by any linked build server”.

3. Why are my deployments under ‘Undefined environment’ or ‘Others’?

   There is no way to tell the deployment environment from Buildkite. To specify an environment with the notification, add a ‘env’ query string to the webhook URL. For example adding ‘&env=development’ behind the webhook URL will tag the deployment under the development environment. Unfortunately we don’t support multiple deployment environments for a single notification.