...
JIRA issues are represented as JIRAPROJECTNAME 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 is always uppercase in case of JIRA issues. |
...
Preparing for JIRA Integration with FlexDeploy
...
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 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
...
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.
...
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#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 work item issue number(s) 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.
...
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
...