Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Issue Tracking 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 out of box integration with Atlassian Jira, 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 to associate tickets.  As 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. Tickets can also be manually associated to an Issue Tracking System on the Build Request Form.

Image Removed

To configure a Jira issue tracking system, select Jira  

Here is the out of box issue tracking systems. To configure, click the name or select a row and click the Edit button. Image Removed
You can provide global customizations for the Jira integration here, or override the settings at the environment, project, or environment/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

...

Yes

...

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.

...

Lastly, as mentioned above, FlexDeploy can configure global environment rules which will apply to all projects in the application unless overridden at the project level.

Image Removed

The selected ticket status for the Auto-approve Tasks on Status field, is for any External Approval Task that gets created for the Development environment. The task is automatically approved when the associated ticket, in the Issue Tracking System, reaches or exceeds the desired status. For more information on the setup of the External Approvals and configuring Issue Tracking System at the Project level, refer to the Issue Tracking System section of the Projects page.

Click the Save button to apply any updates. 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.

Image Added

Terminology

FlexDeploy TermDescription
Issue Tracking SystemDefines 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 InstanceInstance represents the physical connection details of the Issue Tracking System.
PropertyProperties are used to define the necessary inputs needed to connect to the system
StatusStatus 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.

Here is the setup needed for Redmine.