Jenkins Integration for Jira

Background

This project finds its roots in the JIRA Hudson Integration project. That project was plagued by issues effecting large to very large deployments of, at the time, Hudson and now Jenkins. That implementation took a real time approach to showing build data in Jira. However, the larges a Jenkins instance became, the slower the integration became to the point where both Jira and Jenkins would stop performing.

The new implementation is taking a caching approach to showing build data in Jira, this approach greatly simplifies the Jenkins add-on and improves the performance impact of running the integration on both Jira and Jenkins.

Getting Started

Getting started is easy, its a simple 4 step process that is highlighted in the Quick Start Guide.

TL;DR: 1 install Jira add-on, 2 install Jenkins add-on, 3 Configure Jenkins Site in Jira, 4 Enjoin Insight.

Jenkins builds are linked to Jira issues if an issue key of an existing Jira issue can be found in the job and build data that was synchronzied.

The following elements are inspected to extract Jira issue keys:

  • Job display name
  • Job description
  • Job url
  • Build display name
  • Build description
  • Build trigger cause
  • Change-set commit messages

Any potential issue key located will be verified to exist, and a link between the build is issue is only created if the issue exists in Jira.

It is important to note that the issue keys in the commit message must follow the rules set by Atlassian on the format of Project Keys and therefor Issue Keys. Details on the format rules can be found in there documentation Changing the project key format.

Features included in the Jira add-on

All Jira features are limited to Software Projects.


Features included in the Jenkins add-on

The Jenkins add-on is required for the integration with Jira Software Cloud.