Since FlexDeploy 6.5.0.3, 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.
| Tip |
|---|
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: |
...
Jira User |
| Yes | Jira User Name |
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.
Optionally configure for Comment and/or Status update after build or deploy execution.
Work Item pattern is optional . This 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, this is explained in next section.
...
.
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
...
with using commit messages , - use the format #issue for example, #FLEXDEPLOY#GLORY-1234. Or you use FLEXDEPLOYGLORY-1234 in commit message if FLEXDEPLOYGLORY- 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 JIRA issue number(s) on build request form in work items input.
manually with package, just specify JIRA issue number on package configuration.
Linking with Commit Messages
Set up your FlexDeploy Project’s Issue Tracking configuration with a work item pattern. The pattern must be Jira Project name + “-”. If your Jira project name is FLEXDEPLOY, then you can use FLEXDEPLOY-1234 in commit message as FLEXDEPLOY- would be setup as work item pattern.
Alternative you can always just prefix with # and not work item pattern configuration is necessary. For example include #FLEXDEPLOY-1234 in commit message and FLEXDEPLOY-1234 work item will be picked up during build.
Following this pattern, make a commit message.
...
Push and merge your change.
When you create a build, the issue numbers are pulled from your commits.
Linking by Manual Entry at Project Build Time
If you didn’t remember to put the issue number in your commit, and you are building the project manually, you can enter issue numbers at build time.
The issue number should be JIRA Project Name-Number
In this example, it’s FLEXDEPLOY.
...
Linking Issues to Project Packages
If you don’t put issue numbers in your commits and you are working with a package-based project, you can associate issues with packages that will live through its build and deployment lifecycle by following this pattern. Go to the project and package which you wish to link a Jira Issue. Edit the package.
Add one or more Issues. The dropdown only shows previously linked issues. Type the entire issue key to make a new one.
...
Save.
The issue number should be in the format Jira Project Name-Issue Number
For example, GLORY-1. Note that # prefix only necessary with commit message.
manually with package - just specify issue number(s) on package configuration.
See Link Work Items to Project Build for more information about linking Work Items to builds.
Examples
...