Issue Tracking Instance is configuration details to connect with specific issue tracking system like Jira, Azure Boards etc. This information is used to manage Issues - status and / or comments.
To create an Issue Tracking System instance, select the Issue Tracking tab, and click the create button. To edit an existing instance, click on a the name of a specific instance from the list.
Enter values for the fields as described in the table below.
Field Name | Required | Description |
|---|---|---|
Instance Name | Yes | Long display name for the instance. |
Instance Code | Yes | Short name for the instance. |
Issue Tracking System | Yes | Jira, Redmine, Azure Boards, GitLab, and GitHub are the supported out-of-box issue tracking systems. Any custom issue tracking systems you create will also appear as an option here. Once the Issue Tracking Instance is saved, this cannot be modified. |
Description | No | A description of the instance. |
Active | Yes | Whether or not the instance is active in the system. Defaults to "Yes". |
Properties | No | If the selected Issue Tracking System has any properties defined, then you must set up values for those properties based on the property key definition. |
Click the Test Connection button to verify the credentials and other connection details. Click the Save button to save the changes. and exit the popup.
Issue Tracking Systems
The Issue Tracking Systems page, which can be accessed through selecting the Issue Tracking tab on the Integrations page and clicking the Providers button on the top right of the table, allows the management of integrations into the third-party issue tracking systems. FlexDeploy currently provides out-of-box integration with Atlassian Jira, Redmine, Azure Boards, GitLab, and GitHub. You can define a custom implementation using either Java class or Groovy script. FlexDeploy reads ticket(s) from SCM commit message comments during build execution. As an example, if you use SVN when committing a change back to the repository, simply put the issue name in the commit comment (case sensitive). Some SCMs require clients installed on the FlexDeploy Server.
SCM Client Requirements
To use Git, The Git executable must be installed on the FlexDeploy server & build endpoints, and it must be accessible in its PATH. The Git executable version must be 1.7.9 or higher.
To use PVCS, the pcli executable must be installed on the FlexDeploy server & build endpoints, and it must be accessible in its PATH.
To use Surround, the Surround SCM executable must be installed on the FlexDeploy server & build endpoints, and it must be accessible in its PATH. The Surround SCM version must be 2018.2.0 or higher.
FlexDeploy comes with a Java Implementation to integrate with Jira, Redmine, or Azure Boards, and a Groovy implementation to integrate with GitLab or GitHub. You are not allowed to change the implementation class and change or add new properties for these out-of-box issue tracking systems. You can create an additional Issue Tracking Systems as necessary using the Create button. To edit custom Issue Tracking Systems or view out-of-box ones, select its name in the table.
Terminology
FlexDeploy Term | Description |
|---|---|
Issue Tracking System | Defines the system used to track the tickets for specific projects or applications using patterns or custom rules. Various providers are available out-of-box, but you can add one or more custom systems using either Java or Groovy script implementation. |
Issue Tracking System Instance | Instance represents the physical connection details of the Issue Tracking System. |
Property | Properties are used to define the necessary inputs needed to connect to the system. |
Status | Status is used to measure the progress of work done, as well as to represent the current stage of the issue. |
Let's review each topic in detail now.
The issue tracking integrations for out-of-the-box providers are not editable.
For adding a custom issue tracking system, follow the steps described in Custom Issue Tracking System
Create an issue tracking system instance to integrate with FlexDeploy. Configure Issue Tracking System Instance shows how to set up the instance by providing the server and credential information
The next steps after creating and testing the instance is to Configure Project for Issue Tracking. Here you can choose any configured issue tracking system instance and define how you want to integrate with the system
Tickets are associated when a project is built. Associate Issues with Build describes how FlexDeploy processes the tickets
Here is the setup needed for out of the box issue tracking systems.