JIRA Integration
- Karl Henselin
- Jay-Ar Brouillard
- Abhishek Jadhav (Unlicensed)
- Chandresh Patel
Â
All FlexDeploy Jira integrations now support v3 of the Jira REST API. Users who opt into v3 will notice more accurate comments and descriptions when viewing Jira Work Items in FlexDeploy. You can begin utilizing v3 by updating the Jira REST API Pattern property on your Jira Integrations (e.g. /rest/api/3/issue/{JIRA_ISSUE}).
Syntax for JIRA Issues
JIRA issues are represented as JIRAProjectName-NUMBER in FlexDeploy. For example, GLORY-10, GLORY-20 where GLORY is name of JIRA project.
FlexDeploy will accept and show JIRA issues as GLORY-1, GLORY-2 etc. FlexDeploy always uses uppercase Project name in case of JIRA issues.
Preparing for JIRA Integration with FlexDeploy
You need to create an OAuth Token for use in FlexDeploy. This token will be entered for Jira API Token on Issue Tracking Instance.
Go to Jira application and login as the user you want to use for FlexDeploy to JIRA Integration.
Generate an API Token in JIRA following this guide. ​
Create Issue Tracking Instance
A JIRA instance looks like this:
Property Name | Property Code | Required | Description |
|---|---|---|---|
Jira URL |
| Yes | Jira URL (For example http://myjira.atlassian.net) |
Jira User |
| Yes | Jira User Name |
Jira Auth Type |
| No | @since 7.0.0.12 Authentication method for connecting to Jira. Defaults to BasicAuth. Useful for connecting to On-premise instances of Jira where basic authentication will not work with username and password or API token alike. In those cases authentication type must be set to the BearerToken and API token provided. If AuthType is BearerToken, then |
Jira API Token |
| Yes | Jira API Token. See (https://confluence.atlassian.com/cloud/api-tokens-938839638.html) to learn more about API tokens and how to create them. |
Jira Ticket URL Pattern |
| Yes | Jira Ticket URL Pattern (/browse/{JIRA_ISSUE}) |
Jira Rest API Pattern |
| Yes | Jira Rest API Pattern (/rest/api/2/issue/{JIRA_ISSUE}) |
Configure Folder or Project for Issue Tracking
Configure JIRA Issue Tracking Instance on your project or parent folder. Issue Tracking configurations are inherited by sub-folder and projects. This configuration will allow you to integrate JIRA Issues with your project builds. See Configure Project for Issue Tracking for more details.
Work Item pattern is optional if you plan to prefix work item numbers in commit message with #. If specific, this will used to parse source code commit logs for JIRA Issues.
Optionally configure for Comment and/or Status update after build or deploy execution.
Linking JIRA Issues with FlexDeploy Builds
Now you are ready to link JIRA issues with project builds. In order to link
using commit messages - use the format #issue for example, #GLORY-1234. Or you use GLORY-1234 in commit message if GLORY- is setup as work item pattern. You can use one or more issue numbers in commit message, but it is good idea to have separate commits for each issue.
manually at build time - just specify issue number(s) on build request form in work items input. For example, GLORY-1. Note that # prefix only necessary with commit message.
manually with package - just specify issue number(s) on package configuration.
See Associate Work Items to a Build for more information about linking Work Items to builds.
Examples
Â
- style