The Issue Tracking System Systems page, which can be accessed through the Administration - > Integrations - Issue Tracking Systems menu, allows management of integrations into third-party issue tracking systems. FlexDeploy currently provides outbound out of box integration with Atlassian Jira. To configure the Jira issue tracking system, select Jira and click the Edit button.
You can provide global customizations for the Jira integration here, or override the settings at the project level. The customizations available are as follows.
...
Field Name
...
Required
...
Description
...
Id
...
Yes
...
System generated identifier (read-only).
...
Name
...
Yes
...
Name of the issue tracking system (read-only).
...
Description
...
No
...
Description of the issue tracking system.
...
Ticket Number Pattern
...
No
...
Pattern of the issues within the issue tracking system, used to associate FlexDeploy builds with particular issue(s). If not specified here, the pattern will need to be defined on each project which associates to your issue tracking system. For Jira, the pattern of tickets is the Jira project Key, followed by a dash (e.g. "MYPROJ-"). All tickets created for this project are prefixed by this key, making it the pattern.
...
Update Tickets on Build
...
No
...
Check this box if you want to globally update any tickets associated to FlexDeploy builds. Can be overridden at the environment, project, or environment/project level.
...
Build Update Comment Pattern
...
No
...
Applicable only if Update Tickets on Build is checked. The value of this property is a groovy script which evaluates to the comment you wish to update associated tickets with when a build completes successfully. Groovy variables available to the script are provided in the (x=) dropdown to the right. Can be overridden at the environment, project, or environment/project level.
...
Update Ticket Status on Build
...
No
...
Applicable only if Update Tickets on Build is checked. Check this box if you want to globally update the status of any tickets associated to FlexDeploy builds. Can be overridden at the environment, project, or environment/project level.
...
To (Build)
...
No
...
Applicable only if Update Ticket Status on Build is checked. Any associated ticket will be updated to this status whenever the build completes successfully. Can be overridden at the environment, project, or environment/project level.
...
Update Tickets on Deploy
...
Check this box if you want to globally update any tickets associated to FlexDeploy deployments. Can be overridden at the environment, project, or environment/project level.
...
Deploy Update Comment Pattern
...
Applicable only if Update Tickets on Deploy is checked. The value of this property is a groovy script which evaluates to the comment you wish to update associated tickets with when a deployment completes successfully. Groovy variables available to the script are provided in the (x=) dropdown to the right. Can be overridden at the environment, project, or environment/project level.
...
Update Ticket Status on Deploy
...
Applicable only if Update Tickets on Deploy is checked. Check this box if you want to globally update the status of any tickets associated to FlexDeploy builds when they are deployed. Can be overridden at the environment, project, or environment/project level.
...
To (Deploy)
...
Applicable only if Update Ticket Status on Deploy is checked. Any associated ticket will be updated to this status whenever the deployment completes successfully. Can be overridden at the environment, project, or environment/project level.
Issue Tracking System properties provide the definition of configuration parameters that are required to integrate with that system. Values for these properties will be provided when Issue Tracking System Instances associated with the system (e.g. Jira) are configured in the FlexDeploy topology. See the Topology section of this guide for more information. Anchor
Issue Tracking System statuses identify the statuses within your Jira system, and allows FlexDeploy to update your issues to those values at build or deployment time. You will add the statuses from the Jira workflow(s) associated to your Jira project(s). Click the and buttons to add or remove statuses from the list.
To identify the statuses to add, from within your Jira system as seen in Figure 17.62, view the workflow(s) associated to your Jira project(s). Switching to the Text view of the workflow editor/viewer you can identify the workflow statuses and transition ids.
It is critical that the ids entered match the transition ids within your Jira workflows, otherwise, FlexDeploy will be unable provide the desired updates. Click the Save button to apply any updates. , Redmine, and Azure Boards. You can define 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). If using Git as your SCM, make sure that the Git executable is installed on the FlexDeploy server and is accessible on the PATH. The Git executable version must be 1.7.9 or higher.
Here is the out of box issue tracking systems. To configure, click the name or select a row and click the Edit button. FlexDeploy comes with Java Implementation to integrate with Jira, Redmine, or Azure Boards You are not allowed to change implementation class and change or add new properties for these out-of-box issue tracking systems. You can create an additional Issue Tracking System as necessary using the Create button.
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. Jira, Redmine, and Azure Boards 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.
- If you want to configure Jira or Redmine, or Azure Boards use the Configure Issue Tracking Systems to make any changes to properties, status, or other configurations
- For adding a custom issue tracking system, follow the steps described in Custom Issue Tracking System
- Once the Issue Tracking System properties are configured, create an 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
- Tickets are associated when a project is built. Associate Issues with Build describes how FlexDeploy processes the tickets
Here is the setup needed for Redmine.