A plugin for Jenkins CI to update JIRA tickets in an extensible way: both what to update and how to up date are exposed as Extension Points
View jira-ext on the plugin site for more information.
Older versions of this plugin may not be safe to use. Please review the following warnings before using an older version:
0.8 March 23 2019
- Modify MentionedInCommitStrategy to use the comment of the change // pull#10
- Add option to add label to a custom field // pull #17
- Fix issue with non-standard JIRA issue keys // pull #16
- Fix regex search for JIRA issue key in first word of commit // pull #15
- Add Jenkinsfile // pull #11
- Fix MentionedInCommitStrategy for tickets in multiple lines // pull #9
0.7 June 15 2017
- Add support for conditional step plugin JENKINS-35339
0.6.1 December 15 2016
- Add a Publisher for jira-ext steps, so that they can be run as a post-build step
0.5 May 24 2016
- Add environment variable support for update field, add label, add fix version, single ticket strategy JENKINS-33054
0.4.1 March 4 2016
- Fix issue with guice injection affecting job-dsl runs
0.4 March 3 2016
- Add methods to JiraSvc to get field values, update multi-select values, and directly obtain a JiraClient
- Add UI control to discover fieldIds in 'Update a Field' JIRA operation
- Add socket and connection timeouts (10s default, configured in global config)
- Add ability set the Fix-Version of an issue
- Fix bug with global config not persisting between restarts JENKINS-33249
- Fix docs for fieldIds JENKINS-33055
0.2 Feb 4 2016
- Add Job-DSL support
- Add 'Mentioned in commit message' Issue Strategy
0.1 Jan 11 2016
- Initial release
A plugin for Jenkins CI to update JIRA tickets in an extensible way: both what to update and how to update are exposed as ExtensionPoints.
Out of the box, you may discover issues by:
- The issue key as the first word of the commit message
- The issue key as the first word of the upstream commit message
- Manually specifying an issue
- Looking for it being mentioned somewhere in the commit message
To all of these JIRA issues, you may:
- Add a comment
- Update a field
- Add a label
- Transition a ticket (Start Work, Resolve, etc..)
Comparison to jira-plugin
The jira-ext plugin is meant to be extensible in ways that the jira-plugin is not. Both Jenkins and JIRA are used as part of an organizations workflow, and as such are highly customizable. The jira-ext plugin continues this philosophy by making the actions (and when to perform those actions) also customizable for your organization.
In terms of specific features:
- Specify issues manually
- Specify issues from upstream commits
- Transitions issues
- Add label to issues
- Update custom fields
- Customize comments on issues
- Perform release notes
- (Deprecated) support for SOAP
- Specify issues from JQL
- Automatically link back to jenkins builds (backpointers)
- Link JIRA issues in the Jenkins UI
Extending the plugin
The jira-ext plugin is built with extension in mind. Both how to discover issues and what action to take are customizable. They are implemented as ExtensionPoint, meaning your plugin (or a custom plugin) can contribute its own ticket discovery strategies or operations based on logic specific to your installation or environment.
For example, a code review build could provide a link to the code review server in the JIRA issue as a custom field, or as a comment.
Or another example, a production release build could update tickets based on differences between tags, to keep track of what was deployed last.
If you want to add an operation which should be part of any JIRA install, please open a pull request.
Add a custom 'Discover Issues By' option
You may update what tickets to update using an IssueStrategyExtension and IssueStrategyExtensionDescriptor. SeeSingleTicketStrategy for an example.
Add a custom JIRA operation
You may add your own operations using a JiraOperationExtension and JiraOperationExtensionDescriptor. SeeAddComment for an example.
How does the plugin work?
The jira-ext plugin is a build step in Jenkins - it updates JIRA tickets through a REST API:
- The plugin works by parsing out changesets from your SCM - the "what changes". Using those, you can configure it to discover JIRA issue keys - for example, if the issue key is mentioned in the commit message.
- Then, with each of those issues, you can do an operation on your JIRA server for each of those tickets, using JIRA's REST API, for example add an issue. Supported operations are listed in the README, and in the UI.
the 'ext' in the JIRA-ext plugin stands for 'extensible' - both of those bullet points can be extended by writing your own plugin. Jenkins wiki has docs on that:
I have a question, how should I ask it?
The jira-ext plugin is an open source project, and questions should be transparent to benefit the community. In order of preference, please:
- Open a Pull Request in github
- Look for a JIRA issue or create a new one if one does not exist
- Ask on the jenkins user list
If those do not work or get a reply within a week, please contact the author directly.
Dan Alvizu email@example.com
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.