Configure integration with Atlassian Jira

Integrate Atlassian Jira with Unity Version Control to track Jira issues.

阅读时间5 分钟

最后更新于 14 天前

Configure Atlassian Jira and your Unity Version Control (UVCS) client so that you can use the Jira integration. You can set up the following configurations:

Configure your Jira to work with UVCS.
Configure your UVCS client to work with Jira.
Configure the Jira integration for use with multiple projects.
Map fields from Jira to display in UVCS.

Jira configuration

Configure Atlassian Jira so that Jira can connect with Unity Version Control (UVCS).

Create a custom field

Create a custom field so that UVCS can link changesets or branches to a Jira issue. Refer to the Atlassian documentation on how to create a custom field. Make sure to configure the following options:

Select Text Field (multi-line) as the field type.
Select Default Screen as the association of the field to screens.

You can use any name, because UVCS uses the field ID to identify the field. You can find the ID in the URL on the screens page. For example,

fieldID=customfield_1000

Accept remote API calls

Ensure that UVCS can access Jira’s remote API:

注意

In Jira Cloud, the Accept remote API calls option is enabled by default.

Under the System section, select General Configuration.
Enable the Accept remote API calls option.

To test that the connection works in the UVCS application, select the Test Connection button in the Issue trackers section of the Preferences window.

Configure the client for Atlassian Jira

Configure your Unity Version Control (UVCS) client to work with the Jira integration. You can configure the client in Windows or Linux and macOS.

Configure the client on Windows

Configure the Jira integration in the UVCS desktop application:

In the Unity DevOps Version Control desktop application, select the context menu, then select Preferences.
Select Issue Trackers.
Select Bind to this issue tracking system.
Select Atlassian Jira.
Select the repository that you want to apply binding to:
- If you want to bind to all of your repositories with the issue tracker, select Repositories.
- If you want to bind to a particular repository, select that repository.
Select the working mode you want to use:
- Bind issues to Unity VCS branches (recommended): links one task to one branch.
- Bind issues to Unity VCS changesets: links one or more tasks to one or more changesets.
Configure the Jira parameters.

Configure the client on Linux and macOS

Set a local Jira configuration on a Linux or macOS machine:

Create the path
```
issuetrackers/<server_port>/<repository>
```
, and replace
```
repository
```
with one of the following values:
- The name of the repository you want to link to the issue tracker.
- ```
allrepos
```
  to link all of your repositories to the issue tracker.

Copy the

jira.conf

example into the new path from one of the following locations:

Linux:

<plasticscm_install_path>/client/extensions/config_samples

macOS:

/Applications/PlasticSCM.app/Contents/IssueTrackerConfigSamples

In the
```
jira.conf
```
file, edit the WorkingMode parameter to assign one of the following values:
- ```
TaskOnBranch
```
  : links one task to one branch.
- ```
TaskOnChangeset
```
  : links one or more changesets to one or more branches.
Configure the Jira parameters.
Edit your
```
client.conf
```
file to add the following key:


<Extensions>    <Extension AssemblyFile="plasticscm_install_path/client/extensions/jira/jiraextension.dll" /></Extensions>

注意

You can also set a global extension configuration on the server.

Jira parameters

Parameter	Description
Host	Specify the URL where the Jira server is located. The URL must contain the port where the Jira server runs.
User name and Password	Specify the Jira credentials used to log into Jira and log the changes. Note: For Jira Cloud, the User name must be the email address of the account, and the Password must be an API token.
Branch prefix	Optional parameter if you work in the task on branch mode. The prefix links UVCS branches to Jira tasks. For example, 'scm' links branches that start with 'scm'.
Project Key	Specify the key of the Jira project that you want to link to UVCS. To work with multiple projects, this value has to be `MULTIPLE_PROJECTS` .
Custom Field ID	Optional parameter to specify the identifier of the custom field that UVCS uses to log checkin information on Jira tasks. If not set, UVCS doesn’t log any information to Jira tasks so you can only link tasks to changesets or branches but not update the task. Note: Next-gen projects don’t support the Custom Field ID. Leave it blank to add checkin info as a comment.
Use LDAP credentials if available	If Plastic SCM client authentication mode is LDAP, select this parameter to reuse those credentials for Jira login. Both the UVCS server and Jira must share the same LDAP directory.
Use default proxy credentials	Automatically set proxy credentials with default credentials for all Jira extension connections.
Issue query limit	Manually tune the maximum number of returned results in the Create Branch dialog. The default limit is 51.
Resolved issue states	Specify a comma-separated list of status names to consider as resolved. The default status name is Done. UVCS doesn’t display resolved issues on the Create Branch dialog by default.
Issue types	Filters issues by their type. Use a comma-separated list, for example, you can only display bug or task issues and filter out other types. If you use Linux or macOS, you can copy and edit the following line, and paste it in your jira.conf file: `Name=Issue types;Value=Bug,Task;Type=Text;IsGlobal=False` .
Fields mapping	Map the fields from the Jira issue that you want to display on the task information panel in the Branches or Changesets tabs.
REST URL	Specify the path base URL for the REST API. The default value is `/rest/api/2/` .
TASK URL	Specify how to build task page URLs. The default value is `/browse/` . For example, if `Host` is set to `https://my.server.com/jira` and the `TASK URL` is set to `/ticket/` , and the extension has to build the URL to browse ticket `PRJ-001` , the resulting URL is `https://my.server.com/jira/ticket/PRJ-001` .
Status transition	Change the status of the associated issue based on a changeset comment. Refer to transition Jira statuses.

Configure Jira for multiple projects

Configure the Unity Version Control (UVCS) client to work with a multi-project configuration. A multi-project configuration allows each branch to explicitly contain the project key of the related task so you don’t define a global project key for all branches.

Add the project key

When you configure the client for Jira, add the value

MULTIPLE_PROJECTS

to the Project Key parameter.

注意

If you use Linux or macOS, remember to update the required values in your

jira.conf

file.

Link branches

If you work with multi-project configuration, you need to distinguish which branch links to which project. Use the following format to name your UVCS branches:

<BranchPrefix>_<ProjectShortName>-<IssueID>

For example, to link a branch with the prefix

task

to Jira issue

VCS-1

, use the branch name

task_VCS-1

Map Jira fields

Map fields from a Jira issue to display them on the task information panel in the Branches or Changeset tabs in the Unity Version Control (UVCS) desktop application.

Configure the field mapping

Configure the Fields mapping parameter on Windows:

Select the context menu and select Preferences.
Select the Issue tracking tab.
Enter the
field name (
```
from->to
```
) pairs
, separated by
```
|
```
characters.

注意

If you work on a Linux or macOS system, remember to update the required field in the

jira.conf

file.

Field mapping syntax

Use the following syntax for the field mapping parameter:


[ <jira_field_name> -> <vcs_property_name> [ | <jira_field_name> -> <vcs_property_name> [ | ... ] ] ]

Available UVCS property attributes

The

to

attribute in the name pair describes the UVCS field that the

vcs_property_name

refers to. You can use the following attributes:

Id
Owner
Status
Title
Description

Available Jira field attributes

The

from

attribute in the name pair describes the filed in the Jira issue that the

jira_field_issue

refers to. You can use the following attributes:

`from` field value	Field data type
`issue.Fields.Assignee.Name`	`String`
`issue.Fields.AttachmentNames`	`String[]`
`issue.Fields.ComponentNames`	`String[]`
`issue.Fields.Created`	`DateTime`
`issue.Fields.Description`	`String`
`issue.Fields.DueDate`	`DateTime`
`issue.Fields.Environment`	`String`
`issue.Key`	`String`
`issue.Fields.Priority.Name`	`String`
`issue.Fields.Project.Name`	`String`
`issue.Fields.Reporter.Name`	`String`
`issue.Fields.Resolution`	`String`
`issue.Fields.Status.Name`	`String`
`issue.Fields.Summary`	`String`
`issue.Fields.Issuetype.Name`	`String`
`issue.Fields.Updated`	`DateTime`
`issue.Fields.Votes.Number`	`Long`

Use a custom field

To map a custom field, use the

customFieldValues

modifier with the custom field ID number. For example,

customFieldValues[10000]->Description

Field mapping example

For example, the following is a valid example for the following configuration:

Displays the project key in the description.
Displays the Jira description as the title.
Displays the issue creator as the owner.


issue.Fields.Project.Name->Description|issue.Fields.Reporter.Name->Owner|issue.Fields.Description->Title

文档

Development

User Acquisition

Monetization

工业

文档

Development

User Acquisition

Monetization

工业

Unity Version Control

DevOps

On-prem

Gluon

Editor plug-in

Unity Version Control

Configure integration with Atlassian Jira

Jira configuration

Create a custom field

Accept remote API calls

Configure the client for Atlassian Jira

Configure the client on Windows

Configure the client on Linux and macOS

Jira parameters

Parameter

Description

Configure Jira for multiple projects

Add the project key

Link branches

Map Jira fields

Configure the field mapping

Field mapping syntax

Available UVCS property attributes

Available Jira field attributes

`from`
field value

Field data type

Use a custom field

Field mapping example

Configure integration with Atlassian Jira

Jira configuration

Create a custom field

Accept remote API calls

Configure the client for Atlassian Jira

Configure the client on Windows

Configure the client on Linux and macOS

Jira parameters

Parameter

Description

Configure Jira for multiple projects

Add the project key

Link branches

Map Jira fields

Configure the field mapping

Field mapping syntax

Available UVCS property attributes

Available Jira field attributes

from field value

Field data type

Use a custom field

Field mapping example

`from`
field value