Jira plugin

This topic describes how to configure the Jira XL Release plugin.

The Jira XL Release plugin is used to start releases from Jira work flows. The plugin provides a transition post function for this purpose.

As a prerequisite, the reader should have a good understanding of administering Jira work flows, screens and custom fields. For more information, see:

Features

  • Start release from template post function:

    • Global XL Release Server authentication
    • Per issue XL Release Server authentication
    • Per issue XL Release template
    • Matches custom fields on an issue to like named XL Release template variables
    • Passes issue number to XL Release template variable called issue
  • XL Release password field:

    • Custom field type that hides the password on input and display

Requirements

  • XL Release 8.5+
  • Jira 6.3.x, 6.4.x

Installation

Follow the steps provided in the Installing by file upload section of the Atlassian Universal Plugin Manager documentation.

Start release from template Post Function

The post function can be used in a work flow transition. Take note of the ordering of the post function. For example, you may not wish to start a release if another aspect of the transition fails, e.g. saving the Jira ticket.

The function uses predefined custom fields on an issue for input and output. At a minimum, 2 custom fields are required:

  • A field to indicate the release template to start in XL Release
  • A field to capture the XL Release ID after a successful start

Other optional custom input fields are:

  • A field to indicate the XL Release Server URL
  • A field to indicate the username to use for authentication in XL Release Server
  • A field to indicate the password to use for authentication in XL Release Server
  • A field to indicate the release title to use

Any other custom field on an issue is used as input to XL Release template variables. The association is made based on the field name. The issue number is mapped to an XL Release template variable called issue, if present.

The name of the custom fields can be customized via the functions parameter settings.

Any errors encountered are logged as comments on the issue.

Settings

Parameter Description Required Default
Template field name Custom field name that is defined on an issue containing the XL Release template that is used to start the release. The issue must define and set this custom field. Yes XLR Template Name
Release ID field name Custom field name defined on an issue that will register the release ID after the function starts it. The issue must define this custom field. Yes XLR Release ID
URL URL of the XL Release Server. This will be used when no URL is specified on an issue. This parameter can be blank. No http://localhost:5516
Username Username to use for authentication with the XL Release Server. This will be used when no username is specified on an issue. This parameter can be blank. No admin
Password Password to use for authentication to the XL Release Server. Will be used when no password is specified on an issue. This parameter can be blank. No admin
Release title field name Custom field name that is defined on an issue containing the title for the release. This parameter does not need to be defined on issue, it will be automatically generated for the issue number. No XLR Release Title
URL field name Custom field name that is defined on an issue containing the XL Release Server URL. If this custom field is defined and set on an issue, it will override the default setting. No XLR URL
Password field name Custom field name that is defined on an issue containing the XL Release username. If this custom field is defined and set on an issue, it will override the default setting. No XLR Password

XL Release Password Field

Jira does not have a password custom field type. This plugin introduces such a type that hides the password on input and display.

Screenshots samples

The following screenshots are samples from a potential integration scenario.

Workflow

Sample workflow that introduces a Release status. A user will transition to this state from the Done status.

Sample Workflow

Post Function Selection

Sample PostFunction Selection

Post Function Configuration

Sample PostFunction Conf

Release screen

Sample custom release screen that is associated with the workflow transition.

Sample Release Screen

Error comments

Sample error messages logged by the post function to the issue’s comments.

Sample Errors

Successful start of release comment

Sample Start

Release notes

XL Release Jira plugin 9.0.0

  • [XLINT-653] Fixed bug where plugin could not retrieve template variables

XL Release Jira plugin 8.5.0

  • Added compatibility with XL Release 8.5.0