Jenkins Integration for Jira

Welcome to the Jenkins Integration for Jira documentation!

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.

Lite vs Full

Version 4.0.0 introduces a new flavour of the app, namely Jenkins Integration for Jira - Lite, this new lite version is functionally the same as the existing server version of the app but with some key differences.

	Jenkins Integration for Jira - Lite	Jenkins Integration for Jira
Paid vs Free	Free	Paid
Support	Best effort support	SLA based support
Extensibility
Jira Server
Jira Data Center
Jira Cloud

There are also some features differences highlighted on the Features page.

The new lite version of the app was introduces to make it easier for users to get an SLA based support subscription on the Server version of the app while at the same time keeping it available for those that don’t want/need SLA based support. It also makes it possible to add paid extensions to the integration app that would require a support subscription on the main ‘Jenkins Integration for Jira’ app.

Getting Started

Getting started is easy, it’s a simple 4-step process that is highlighted in the Quick Start Guide.

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

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

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
Git branch names

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.