Since FlexDeploy 7.0.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.

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.

1. Go to Jira application and login as the user you want to use for FlexDeploy to JIRA Integration.

2. Generate an API Token in JIRA following this guide. ​

Create Issue Tracking Instances

A JIRA instance looks like this:

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. 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

• using commit messages, use the format #issue for example, #FLEXDEPLOY-1234. Or you use FLEXDEPLOY-1234 in commit message if FLEXDEPLOY- is setup as work item pattern.

• manually at build time, just specify work item number on build request form in work items input.

• manually with package, just specify work item number on package configuration.

Linking by 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 work item number in your commit, and you are building the project manually, you can enter work item numbers at build time.

The work item number should be JIRA Project Name-Number. In this example, it’s FLEXDEPLOY-1234.

Linking to Project Packages

If you don’t put work item numbers in your commit message and you are working with a package-based project, you can associate work items with packages that will live through its build and deployment lifecycle. Go to the project and package which you wish to link a work item. Edit the package.

Add one or more work item. The dropdown only shows previously linked work items. Type the entire work item key to enter a new one.

Save. Now, builds and deployments of this package will be linked to these work items.