Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{jenkins-plugin-info:jira}
Excerpt

This plugin integrates Atlassian JIRA to Jenkins.


TOC:

Table of Contents
maxLevel4

Using JIRA REST API

First, you need to go to Jenkins' system config screen to tell Jenkins where's your JIRA.

On JIRA side, there is no action necessary as the REST API is enabled by default.

This plugin has an optional feature to update JIRA issues with a back pointer to Jenkins build pages. This allows the submitter and watchers to quickly find out which build they need to pick up to get the fix.

...

titleIncompatible change

...


JIRA

...

Using JIRA RPC SOAP (deprecated)

NOTE: This connection type is only supported in plugin v. 1.41 and lower.

Go to the general configuration screen and enable remote API calls.

Again, this is only needed if you use the abovementioned optional feature, and if you forget to do so, Jenkins will nicely warn you.
Image Removed

With that, JIRA keys in changelogs are now hyperlinked to the corresponding JIRA pages (complete with tooltips!)

JIRA Issue links in build Changelog

...

You can also generate release notes to be used during your build. These notes can be retrieved from an environment variable. See the the Maven Project Plugin for the environment variables found within the POM.

...

Sample usage of generated Release Notes:

JIRA Authentication & Permissions required

Note: As a rule of thumb, you should be always using a service account (instead of a personal account) to integrate Jenkins with JIRA.

Make sure that the JIRA user used by Jenkins has enough permissions to execute its actions. You can do that via JIRA Permission Helper tool.

  • For creating JIRA issues, the user has to be able to Create Issues in the specified project
  • If you additionally enter assignee or component field values, make sure that:
    • both of the fields are assigned to the corresponding JIRA Screen
    • the JIRA user is Assignable in the project
    • the Jenkins JIRA user can Assign issues
JIRA Cloud

In Atlassian JIRA Cloud, it's not possible to create a user without an email, so you need to create API token.

Then create a global Jenkins credential, where you put Atlassian ID email as username and API token as password.

You can check if your API token works correctly by getting a correct JSON issue response with this command (where TEST-1 is an example issue in your project):

Code Block
$ curl -X GET -u <email>:<API token> -H "Content-Type: application/json"  https://<YourCloudInstanceName>.atlassian.net/rest/api/latest/issue/TEST-1

Also make sure that CAPTCHA is not triggered for your user as this will prevent the API token to work - see CAPTCHA section in Atlassian REST API documentation.


System properties

Property Name

Functionality Change

-Dhudson.plugins.jira.JiraMailAddressResolver.disabled=true

Use to disable resolving user email from JIRA usernames. Currently there is no option for this in UI.

Related Resources

Releases

Version 3.0.11 (2019-11-21)
Version 3.0.10 (2019-09-26)
  • dependencies cleanup (remove dependency on org.codehaus.jackson:*)
Version 3.0.9 (2019-08-21)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.9
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.8 (2019-06-28)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.8
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.7 (2019-05-01)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.7
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.6 (2019-03-30)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.6
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.5 (2018-11-07)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.5
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.4 (2018-10-26)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.4
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.3 (2018-10-16)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.3
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.2 (2018-09-25)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.2
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.1 (2018-08-22)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.1
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 3.0.0 (2018-05-20)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-3.0.0
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.5.2 (2018-05-04)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-2.5.2
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.4.2 (2017-08-08)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-2.4.2
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.4 (2017-08-03)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-2.4
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.3.1 (2017-05-23)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-2.3.1
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.3 (2016-12-19)

Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-2.3
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.2.1 (2016-03-26)

Jira Issues
renderModestatic
cacheoff
columnsType,Key,Summary,Status

...

sortenabled
urlhttps://issues.jenkins-ci.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery=labels+%3D+jira-plugin-2.2.1

Version 2.2 (2016-02-20)
  • Split each SCM changes in paragraphs
  • support release candidates (RCs) via Maven ComparableVersion
  • Console logging improvements in various places
  • JiraEnvironmentVariableBuilder support
  • Support adding labels to updated issues
  • (optionally) add scm entry change date and time to description in JIRA tickets

Also the related tickets were fixed:

...


Jira
serverJenkins JIRA
columnstype,key,summary,status
maximumIssues20
jqlQuerylabels = jira-plugin-2.2
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.1 (2015-11-18)
  • Bumped Jenkins Core to LTS v. 1.609.3
  • Added dependencies: mailer-plugin, matrix-plugin
  • Removed dependencies: maven-plugin

...

Jira

...

server

...

Jenkins JIRA
columns

...

type,

...

key,

...

summary,status

...

maximumIssues

...

20

...

jqlQuerylabels = jira-plugin-2.1
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.0.3 (2015-10-26)

...

Jira

...

server

...

Jenkins JIRA
columns

...

type,

...

key,

...

summary,status

...

maximumIssues

...

20

...

jqlQuerylabels = jira-plugin-2.0.3
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.0.2 (2015-09-15)

...

Jira

...

server

...

Jenkins JIRA
columns

...

type,

...

key,

...

summary,status

...

maximumIssues

...

20

...

jqlQuerylabels = jira-plugin-2.0.2
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.0.1 (2015-09-10)

...

Jira

...

server

...

Jenkins JIRA
columns

...

type,

...

key,

...

summary,status

...

maximumIssues

...

20

...

jqlQuerylabels = jira-plugin-2.0.1
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 2.0 (2015-09-02)
Note

Incompatbile change: switch from JIRA RPC SOAP to JIRA REST API communication - the former has been deprecated and dropped since JIRA v.7.0. 

...


Jira

...

server

...

Jenkins JIRA
columns

...

type,

...

key,

...

summary,status

...

maximumIssues

...

20

...

jqlQuerylabels = jira-plugin-2.0
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 1.41 (2015-06-10)

...

Jira

...

server

...

Jenkins JIRA
columns

...

type,

...

key,

...

summary,status

...

maximumIssues

...

20

...

jqlQuerylabels = jira-plugin-1.41
serverIddd058dce-0c66-3b77-8b09-71b1d7728747

Version 1.39 (Oct 6, 2013)

...

  • Add build parameter that providers a drop-down with JIRA release versions
  • Add a build wrapper that will assemble release notes based on issues in the release version and store it in an environment variable

    Code Block
         # Issue Type
        - [JIRA-123] Issue summary
        - [JIRA-124] Another Issue summary
        # Another Issue Type
        - [JIRA-321] Yet another issue summary
    
  • Add a post-build action that will mark a version as released in JIRA

...