Getting Started

Here are the initial steps you need to follow in order to get Jenkins for Jira up and running.

Install the Jira app from the Atlassian Marketplace

You need to download the app Jenkins for Jira from the Atlassian Marketplace.

How to get the app while working in Jira

On the top menu bar select Apps > Find new apps:

You will arrive on the Atlassian Marketplace main page. Search ‘Jenkins integration’:

The first result should be Jenkins for Jira. Click anywhere in the square box:

Click ‘Try it free’:

Click ‘Start free trial’:

A message stating that it is downloading will appear:

The app normally downloads within one minute.

Get app directly from the Atlassian Marketplace

Go to the Atlassian Marketplace and search ‘Jenkins Integration’. Or click here to go directly to Jenkins for Jira:

Click on Jenkins for Jira:

Select the version of Jira you use:

Click ‘Try it free’ button:

Click ‘Start free trial’ under cloud. You need to be logged into an Atlassian account with permission to download apps from the Atlassian Marketplace:

Choose the site you want to add the app to then click ‘Start free trial’:

You will be directed to your Jira instance. Click ‘Start free trial’:

A message stating that it is downloading will appear:

The app normally downloads within one minute.

Installing the Jenkins plugin

You also need to download a plugin on the Jenkins side called Jira Integration. It is required.

Go to your Jenkins homepage

Manage Jenkins > Manage Plugins

Under Manage Plugin

Click on the Available Plugins.

Under Plugins

Search for jira integration and check the ‘Install’ checkbox

Click ‘Download now and install after restart’

Check ‘Restart Jenkins when installation is complete and no jobs are running’ to restart Jenkins.

Connecting Jira and Jenkins

Now you are ready to configure your first Jenkins site (an instance of Jenkins) and enable jobs to synchronize. This is important to do right away as it establishes the data connection between Jira and Jenkins. If you do not do this you will not get any Jenkins data in Jira.

From the top navigation in Jira, choose Gear Icon > Manage Apps

Choose Jenkins Integration > Manage Sites and then click Connect your first Jenkins Site

This brings up the Connect a Site wizard. Create a name of the site you are adding, and provide the site URL.

Under Connection select the directionality of the integration

If select Bidirectional:

Note the following if select Bidirectional:

If select Tunnelled:

Select this option to benefit from bidirectional integration even if Jenkins is not internet facing.

If select Unidirectional:

Select this option if the Jira app can’t access the Jenkins site directly.

Click Save and Connect to accept connection defaults and connect the site. See Jenkins Sites for the all the details and defaults.

Under Connect Site select the method for connecting the Jenkins site

• Select Automatic to let the app register itself with Jenkins. You will need to provide Jenkins administrative credentials to use this. (Only available for Accessible Sites)
• Select Manual to use the provided Registration Link to manually register the Jira site in Jenkins.
• Select Configuration as Code to use the Jenkins Configuration as Code feature to register the Jira site through configuration code.

Click Connect to finalise the connection.

Recommended Reading

We strongly recommend you read about how data synchronization works and how builds are linked to issues. It is also recommended to read about the other options available when connecting a site.