How to use UVCS Jira extension#

The UVCS desktop client provides support to work with Jira issue tracker, adding some nice features as:

• Create new branch from a existing Jira task.
• Display related Jira tasks information for branches and changesets.
• Checkin operations record attached to tasks in Jira.
• Automatic status transitions.

Configure Unity Jira connection in UVCS Desktop#

In order to have synchronized the Desktop client with a Jira server (Jira), next steps should be followed.

1. Open Preferences window from UVCS and go to Issue trackers tab:

   

2. Select Bind to this issue tracking system:

   

   Here you can choose the different loaded repositories or apply the configuration to all of them selecting the first Repositories entry from the list. On the other hand it's important to take into account the desired working mode, by branches or changesets.

3. Then fill the configuration

   Client configuration - Parameters#

   • Host: Specifies the URL where the Jira server is located. Note that the URL must contain the port where the Jira server is running.

   • User name and Password: Specify the Jira credentials used to log into Jira and log the changes. Note that these fields can be the user credentials in Jira, or the credentials of a different Jira user specifically created to log UVCS changes. The issue history on Jira will display the change as coming from the user configured here.

   Important for Jira Cloud users If you use Jira Cloud, the User name must be the email address of the account, and the Password must be an API token. You can find out how to generate API tokens for your Atlassian Cloud account in their official documentation.

   • Branch prefix: If you are going to work on the Task on branch mode, specifying this parameter is recommended (but not mandatory). This branch prefix will be used to bind the UVCS branches to the Jira tasks. For example, if you enter the scm prefix, then all branches whose name starts with prefix scm will be linked to the Jira tasks.

   • Project Key: Specifies the key of the Jira project whose issues will be related to the UVCS branches.

   • Custom Field ID: This parameter is the identifier of the custom field to be used for logging the UVCS checkin information on Jira tasks. This field is built adding the custom field id that Jira assigned when creating the field. This parameter is optional. If it is not set in the configuration, UVCS will not log any information concerning the checkin into Jira's related issue. The user can still benefit from Jira integration while creating branches from Jira issues, or from browsing Jira issues from the Branch Explorer.

   Important for Next-gen projects Next-gen projects do not support this field. Leave the Custom Field ID blank to have the checkin info added as a comment.

   • Use LDAP credentials if available: If the UVCS client authentication mode is LDAP, then the Jira Extension can be configured to reuse those credentials to log in to Jira by checking the this parameter. Please have in mind that both UVCS Server and Jira must share the same LDAP user directory for this functionality to work.
   • Use default proxy credentials: Automatically sets the proxy credentials with the default credentials for all Jira extension connections.
   • Issue query limit: This parameter is used to manually tune the maximum number of returned results in the Create Branch dialog. Its default value is 50, and it can be set to any positive number.
   • Resolved issue states: Holds a comma-separated list of status names to be considered as "resolved". The default value is Done, so no issues with status Done will be shown in the task list on the Create Branch dialog by default.
   • Issue types: Lets you filter the issues the Jira extension retrieves by their type. Just enter a comma-separated list of issue types. This is useful, for example, if you only want to see in UVCS Bug or Task issues, filtering out the rest. If you are using GNU/Linux or macOS, you can copy and edit as you need the following line, and paste it in your jira.conf file: Name=Issue types;Value=Bug,Task;Type=Text;IsGlobal=False
   • Fields mapping: Lets you map the fields from the Jira issue that will be displayed on the task information panel in the Branches or Changesets views.
   • Status transition: Lets you change the status of the associated issue based on a changeset comment. This feature works binding issues to both branches and changesets.

4. Test Connection: Once the configuration is done click on the Test connection button to verify the server connection.

5. Save Configuration, just click on the Save button and the window will be closed.