Versions Compared

Key

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

...

Property Name

Property Code

Required

Description

Jira URL

JIRA_URL

Yes

Jira URL (For example http://myjira.atlassian.net)

Jira User

JIRA_USER_NAME

Yes

Jira User Name

Jira Auth Type

JIRA_AUTH_TYPE

No

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_USER_NAME value is not used. You can set any value for JIRA_USER_NAME in that case as it is required.

Jira API Token

JIRA_PASSWORD

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

JIRA_TICKET_URL_PATTERN

Yes

Jira Ticket URL Pattern (/browse/{JIRA_ISSUE})

Jira Rest API Pattern

JIRA_TICKET_REST_PATTERN

Yes

Jira Rest API Pattern (/rest/api/2/issue/{JIRA_ISSUE})

...

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.

...

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

...