Skip to content

xebialabs-community/xlr-rally-plugin

Repository files navigation

XL Release Rally plugin

Preface

This document describes the functionality provided by the xlr-rally-plugin.

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

Build Status Build Status License: MIT Github All Releases xlrtdk

Overview

The xlr-rally-plugin is a XL Release plugin that allows to integrate XL Release with Rally.

Requirements

  • Requirements
    • XL Release 8.0+
  • Remark
    • Version 3.x is based on pyral. As such it doesn't require any additional jars. However it will require some changes compared to 2.x (Different URI for the Shared Configuration and also requires to define the project)
    • Version 2.x is not backwards compatible with version 1.x. This means you'll have to reconfigure some tasks.

Installation

  • Place the plugin JAR file into your SERVER_HOME/plugins directory.
  • Restart the server

Task Types

  • CreateDefect
  • CreateTask
  • UpdateProperties
  • CreateUserStory
  • UpdateOwner
  • UpdateScheduleState
  • UpdateParent
  • GetStatus
  • Query Status

Configuration

First, you need to add an entry in the Configuration section with information on how to connect to your Rally instance:

Configuration

For URI, make sure to use something like rally1.rallydev.com (without http or https)

Usage

The next step is to add the whatever Rally task(s) you need in your release template (see above Task Types). For example:

Configuration

Properties

Properties depend on the object you're creating or updating. Each object type has it's own set of properties. Note, properties are defined in the following format:

{ "State":"In-Progress", "Description":"My Description" }

The 'key' ("State" in this example) is the name of the property. The 'value' ("In-Progress" here) is the desired value. Multiple key-value pairs are separated by commas. Check the Rally Object Model reference available in the Rally Help menu for more information.

In the example above the Task TA3 has been updated with a new description and it's state has been progressed.

Execution

Rally object reference

When you see a reference to 'Formatted Id', this is the Rally object ID prefixed with the object type. Below are common Rally object types and their associated code. To create a 'Formatted Id', enter <code>+<the id number>. For example, a User Story Id might be 'US12345'.

Defect
  • code: DE
  • default state progression: Submitted, Open, Fixed, Closed
Defect Suite
  • code: DS
Iteration
  • default state progression: Planning, Committed, Accepted
Task
  • code: TA
  • default state progression: Defined, In-Progress, Completed
Test Case
  • code: TC
User Story
  • code: US

Query Status

QueryStatus

Rally Tile

This tile can be used to capture rally records based on a query

Tile Configuration

Configuration

Tile Preview

Configuration