Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. Project name is always uppercase 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.

...

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 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-1234. Or you use FLEXDEPLOY-1234 in commit message if FLEXDEPLOY- is setup as work item pattern.

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

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

Linking

...

by Commit Messages

Set up your FlexDeploy Project’s Issue Tracking 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.

...

If you didn’t remember to put the issue work item number in your commit, and you are building the project manually, you can enter issue work item numbers at build time.

The issue 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 issue work item numbers in your commits commit message and you are working with a package-based project, you can associate issues work items 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 Issuework item. Edit the package.

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

...

Save.

The issue number should be in the format Jira Project Name-Issue Number

Now, builds and deployments of this package will be associated to that Jira Issuelinked to these work items.