JIRA2.5Minimum Jenkins requirement: 1.642.3ID: jira
View Jenkins JIRA plugin on the plugin site for more information.
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.
Starting from this plugin version 2.0, it is using JIRA REST API to communicate instead of JIRA RPC SOAP which has been deprecated and removed since JIRA v.7.0.
If you have an older JIRA version and still want to use JIRA RPC SOAP, do not upgrade the plugin.
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.
With that, JIRA keys in changelogs are now hyperlinked to the corresponding JIRA pages (complete with tooltips!)
JIRA Issue links in build Changelog
When you configure your JIRA site in Jenkins, the plugin will automatically hyperlink all matching issue names to JIRA.
If you have additionally provided username/password to JIRA, the hyperlinks will also contain tooltips with the issue summary.
Updating JIRA issues with back pointers
If you also want to use this feature, you need to supply a valid user id/password. If you need the comment only to be visible to a certain JIRA group, e.g. Software Development, enter the groupname.
Now you also need to configure jobs. I figured you might not always have write access to the JIRA (say you have a Jenkins build for one of the Apache commons project that you depend on), so that's why this is optional.
And the following screen shows how JIRA issue is updated:
By taking advantages of Jenkins' fingerprint feature, when your other projects that depend on this project pick up a build with a fix, those build numbers can also be recorded in JIRA.
This is quite handy when a bug is fixed in one of the libraries, yet the submitter wants a fix in a different project. This happens often in my work, where a bug is reported against JAX-WS but the fix is in JAXB.
For curious mind, see this thread for how this works behind the scene.
Referencing JIRA Release version
To reference JIRA Release versions in your build, you can pull these releases directly from JIRA by adding the JIRA Release Version Parameter.
This can be useful for generating release notes, trigerring parameterized build, etc.
Generating Release Notes
You can also generate release notes to be used during your build. These notes can be retrieved from an environment variable. See the Maven Project Plugin for the environment variables found within the POM.
After your build has run, you can also have the plugin mark a release as resolved. This typically will be a release you specified in your Build Parameters.
The plugin can also move certain issues matching a JQL query to a new release version.
Sample usage of generated Release Notes:
JIRA Permissions required
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
Use to disable resolving user email from JIRA usernames. Currently there is no option for this in UI.
- Check also the Marvelution Jira Hudson Integration which provides a two-way solution Hudson->JIRA and JIRA->Hudson
- Hudson integration for JIRA adds Hudson information to JIRA.
- The Subversion JIRA plugin also allows recording of scm changes to JIRA issues (for other SCMs there are similar plugins)
- For JIRA Workflow (Pipeline) plugin compatibility see COMPATIBILITY.md
Version 2.4.2 (2017-08-08)
Version 2.4 (2017-08-03)
Version 2.3.1 (2017-05-23)
Version 2.3 (2016-12-19)
Version 2.2.1 (2016-03-26)
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:
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
Version 2.0.3 (2015-10-26)
Version 2.0.2 (2015-09-15)
Version 2.0.1 (2015-09-10)
Version 2.0 (2015-09-02)
Incompatbile change: switch from JIRA RPC SOAP to JIRA REST API communication - the former has been deprecated and dropped since JIRA v.7.0.
Version 1.41 (2015-06-10)
Version 1.39 (Oct 6, 2013)
- Ability only to comment issue without processing of workflow (pull #38)
Version 1.38 (Aug 23, 2013)
- Post build step to create new JIRA version (pull #30)
Version 1.37 (Jun 21, 2013)
- Error with empty alternative url issue #18229
Version 1.35 (Jul 29, 2012)
- Prevents multiple comments on one issue for matrix builds. (PR #13)
Version 1.34 (Jun 11, 2012)
- Fix NPE when Jenkins user does not have access to perform any workflow actions JENKINS-13998
Version 1.33 (Jun 1, 2012)
- Support workflow steps as build actions and/or post-build notifiers JENKINS-13652
Version 1.32 (May 15, 2012)
- Option to show archived versions.
Version 1.31 (May 1, 2012)
- Add JiraIssueMigrator - a post build action that will move issues to a new fixVersion based on a JQL query.
- Add Additional filtering of issues to be included in the release notes. Defaults to 'status in (Resolved, Closed)'
Version 1.30 (April 25, 2012)
- 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
- Add a post-build action that will mark a version as released in JIRA
Version 1.29 (August 25, 2011)
- JENKINS-10817 Jira-plugin should add the overall build result to the issue's comment
- Include revisions also for non-subversion plugins; include revisions also if we don't have a repository browser
- Defined a new parameter type for parameterized builds that allow you to select a JIRA ticket (from the result of a JQL query)
Version 1.28 (Jun 15, 2011)
- Improve the form validation error check JENKINS-9625
- Supported security level of the comment JENKINS-1489
Version 1.27 (Feb 27, 2011)
- Updates for Jenkins
Version 1.26 (Jan 14, 2011)
- (JENKINS-2508) : JIRA plugin not updating JIRA when perforce plugin used.
- (JENKINS-6758) : Failed to save system settings with JIRA Plugin.
- (JENKINS-6462) : Version 1.355 of Hudson and Jira Plugin 1.21: Images in Jira comments are not showing up.
- (JENKINS-6264, JENKINS-6282) fixed : IndexOutOfBoundsException when no issue pattern is configured (default pattern wasn't used)
- (JENKINS-6381) fixed : configured patterned wasn't used for changelog annotation. Default pattern was always used for that.
- improved default pattern to not match commit messages with dots in the number part (like 'projectname-1.2.3'). These messages are e.g. used by the Maven release plugin
- (JENKINS-6043) : Issue pattern can be configurable
- (JENKINS-6225) : option to update jira issue whatever the build result is (even if failed)
- Added Japanese localization (JENKINS-5788)
- Fix: Prevent carrying forward invalid issue ids forever
- Case insensitive matching of JIRA ids also in the 'recent changes' view (JENKINS-4132)
- fetch missing details for JIRA issues - i.e. completes issue title tooltip in 'recent changes' view (JENKINS-5252)
- prevent build FAILURE if JIRA site is not available (JENKINS-3046)
- Fixed an
ArrayIndexOutOfBoundsExceptionwhen JIRA issues contain '$' in the name.
- Support underscore in project names (JENKINS-4092)
- Support digits in project names (JENKINS-729)
- Case insensitive matching of JIRA ids (JENKINS-4132)
- Don't strip JIRA id from posted comment
- German translation
Version 1.15 (2008/08/22)
- Update JIRA if the build is UNSTABLE or better. Previously only updated if the build was stable.
- Include relevant SCM comment in the JIRA comment which should make JIRA ticket history more meaningful.
Version 1.13 (2008/08/05)
- Fixed a performance issue in a large enterprise deployment of JIRA (JENKINS-1703)
- A typo in the commit message shouldn't break builds (JENKINS-1593)
- Postpone JIRA updates until a successful build is obtained (JENKINS-506)
- Added more logging and debug flag to examine issues that people are reporting (report)
- Fixed NPE when failed to talk to JIRA (JENKINS-1097)
- Fixed NPE when username/password is not set (JENKINS-828)
- Relaxed the JIRA project key regexp a little bit to allow numbers (JENKINS-729)
- Issue hyperlinking is now smart enough not to be confused by strings that look like JIRA issue that actually aren't.
- Fixed a bug that prevented tooltips for JIRA issues from being displayed JENKINS-694