Polarion integration
Learn how to configure and use the Polarion extension with Unity Version Control (UVCS).
Configure Polarion
Configure Polarion to work with Unity Version Control (UVCS).
Add the UVCS plugin to Polarion
Add the plugin so that you can link UVCS changesets to Polarion workitems:
- Stop the Polarion service.
- Copy the directory
com.codicesoftware.platform.repository.external.plasticscm
from theclient/polarion
folder in the UVCS installation directory to the Polarion extensions folder in[Polarion installation]/polarion/extensions
. - Start the Polarion service.
Create a new repository
Create a repository in Polarion to link to a UVCS repository:
- In Polarion, select Administration > Repositories.
- Select Add New Repository.
- Enter the following information:
Parameter Description ID The identifier for this repository in Polarion. Name The name to display in Polarion. Repository Name The name of the Plastic SCM repository. Server The UVCS server. Plastic Cm Executable The path of the cm executable on the Polarion server side. Note: If no UVCS installation exists on the Polarion server side, then you can copy the UVCS client folder into it. A valid client.conf
must be in this client folder where the cm executable is.
Configure the client for Polarion
There are different methods to configure the client depending on your operating system:
Regardless of your operating system, you need to configure the Polarion parameters.
Configure the client on Windows
- 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 Polarion.
- 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 with codeBeamer, 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 Polarion parameters.
Configure the client on Linux and macOS
Set a local Polarion configuration on a Linux or macOS machine:
- Create the path
issuetrackers/<server_port>/<repository>
, and replacerepository
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
polarion.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
.
- Linux:
- In the
Polarion.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 Polarion parameters.
- Edit your
client.conf
file to add the following key:<Extensions> <Extension AssemblyFile="plasticscm_install_path/client/extensions/polarion/polarionextension.dll" /> </Extensions>
Note: You can also set a global extension configuration on the server.
Polarion parameters
Use the following parameters to further configure your Polarion integration:
Parameter | Description |
---|---|
Polarion Base URL | Specifies the URL where the Polarion server is installed and running. |
User name and Password | Fill these fields with a valid Polarion user. |
Branch prefix | If you are going to work on the Task on branch mode, it's recommended that you specify this parameter. The branch prefix binds UVCS branches to the Polarion tasks. For example, if you enter the scm prefix, then all branches with a name that starts with prefix scm link to Polarion issues. |
Work Item Statuses | These are the work item types that display on the Pending tasks list when you create a new branch with the From task mode. UVCS checks these values when you link new revisions with the Task on changeset mode. Separate these statuses with a vertical bar. |
Open Work Item Status | The new status to give the Polarion task has if the user creates a new branch with the From task mode and also enables the Mark as open in issue tracker option. |
Repository ID | This parameter is the same ID field configured in the Polarion server side. |
Default Repository | Select a repository to be your default. If you don't select a repository, then you have support for multiple repositories. |
Use the Polarion integration
Use one of the following working modes for your Polarion integration:
Task on branch workflow
Task on branch is the default working mode. Each Polarion task links to a branch in Unity Version Control (UVCS).
Link a branch to an issue
The branch name connects the branch to a Polarion issue:
- Create a work item in Polarion. Polarion assigns each task a number. Refer to the Polarion documentation on how to create a work item.
- Create a new branch in UVCS. To link the branch, name the branch with the Polarion task number, preceded by the branch prefix.
- For example, if you configured the branch prefix
task
, and the Polarion task number is 4, name the branchtask004
.
- For example, if you configured the branch prefix
Task on changeset workflow
The task on changeset working mode allows you to link multiple changesets to multiple branches
Link a changeset to an issue
Use the UVCS desktop application to link changesets to Polarion issues:
- Create a work item in Polarion. Refer to the Polarion documentation on how to create a work item.
- Make the changes in UVCS.
- On the Pending Changes tab, select Show tasks to open the tasks side panel.
- Select the Add new issue (+) icon.
- Select issues from the list of pending tasks, or enter a comma-separated ID list if you can’t find the correct issue.
- Select OK.
To log the checkin information in the related Polarion issue, enter a comment in the Checkin comments field, start the comment with the #
character followed by the issue key.