Skip to content

xebialabs-community/xlr-jira-extension-plugin

Repository files navigation

XLR 9.0.0 Migration instructions

If upgrading to XL Release 9.0.0 and you currently use the xlr-jira-extension-plugin provided on xebialabs-community, you must use the xl-ci-tool to migrate the tasks to the new in-sourced tasks. Please follow the steps available on our docs site

Preface

This document describes the functionality provided by the xlr-jira-extension-plugin.

See the XL Release Documentation for background information on XL Release and release concepts.

CI status

Build Status Codacy Code Climate License: MIT

Overview

The xlr-jira-extension-plugin provides additional Jira tasks beyond the default Create Issue and Update Issue supplied by default with XL Release.

Installation

Place the latest released version under the plugins dir.

Types

JiraTrigger

Trigger when a new issue appears top of the search results of a JQL query (like a new release issue, a specific subtask, etc).

JiraTrigger

Check Issue

CheckIssue

  • Check Issue (statuses) - Polls Jira to check the status of a Issue. It will complete once the issue is in the correct status
    • jiraServer - Jira server from the Configuration screen in XL Release
    • username - Optional username override for the connection to Jira
    • password - Optional password override for the connection to Jira
    • issueId - Jira issue ID to check, e.g. SAN-672
    • expectedStatusList - This is the Jira statuses to complete on, the task will poll until one of these status is met. This checks for a status name, e.g. "Resolved". To double check the case of a status, export an issue to XML and check the value of the status field.
    • pollInterval - Interval in seconds between polling actions
    • finalStatus - Output property that will contain the final status. This can be saved in a release variable and used later in the release.

Check Query

CheckQuery

Check Query No Poll

CheckQueryNoPoll

Get All Sprints

GetAllSprints

  • Get All Sprints - Get all sprints for a certain board name
    • jiraServer - Jira server from the Configuration screen in XL Release
    • username - Optional username override for the connection to Jira
    • password - Optional password override for the connection to Jira
    • boardName - Filters results to boards that match or partially match the specified name.
    • sprints - Output property - Map containing Sprint Name and id.

Get Versions

GetVersions

Query For All Issue IDs

QueryForIssueIds

  • Check Status - Polls Jira to check the status of a Issue, will complete once the issue is in the correct state
    • jiraServer - Jira server from the Configuration screen in XL Release
    • username - Optional username override for the connection to Jira
    • password - Optional password override for the connection to Jira
    • issueId - Jira issue ID to check, e.g. SAN-672
    • expectedStatus - This is the Jira status to complete on, the task will poll until this status is met. This checks for a status name, e.g. "Resolved". To double check the case of a status, export an issue to XML and check the value of the status field.
    • pollInterval - Interval in seconds between polling actions

Get Issue Details

  • Get the details for a specific ticket
  • Issue Id - Issue Ticket

GetIssueDetails

Create Issue JSON

Create a JIRA Issue with required fields using a JSON object to specify all of the required fields

CreateIssueJson