Plug-in Documentation

JIRA for IBM UrbanCode Deploy

Overview

The JIRA plug-in includes steps to automate working with JIRA issues as a process step.

This plug-in includes these steps.

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0 or later.

This plug-in runs on all operating systems that UrbanCode Deploy supports.

For JIRA version older than v5.0, please use plugin v5 which uses the SOAP API.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 13

  • RFE 119842 Add support for setting additional standard and custom field values on issue create/transition.
  • Rename the Update Issue step to Transition Issue.
  • Add a new Edit Issue step, for editing fields on an existing issue.
  • When creating an issue, only set the Due Date field if the specified project and issue type allow it.

Version 12

Fix issue with setting proxy port.

Version 11

Add the ability to trust all certificates.

Version 10

Fixes APAR PI84297: Fix response text encoding.

Version 9

  • Fixes APAR PI79900 Support added for Http Web Proxies.
  • Added ability to create issues with Parent IDs and attach labels.
  • The Create Issues step now uses a text box, instead of a select box, to define Properties. All steps will need to be updated with the appropriate priority label.

Version 8

Support property file encryption.

Version 7

Updated step and property descriptions.

Version 6

Fixes Story 107389 Change WSDL/SOAP to RESTful services. The REST API requires JIRA v5.0+. For JIRA version older than v5.0, please use plugin v5.

Version 5

Fixes APAR PI37115 Steps failing with Assertion Error

Version 4

Fixes APAR PI35342 compatibility defect with IBM Urbancode Deploy version 6.1.0.4 and later.

Version 3

The JIRA integration provides component process steps to create, comment and resolve issues found in JIRA and publish a list of issues that were addressed in the deployment.

Usage

With the JIRA plug-in, you work with issues in the JIRA database by executing IBM Urban Code process steps. This plug-in uses the JIRA REST application program interface to communicate with the JIRA user interface.

Step palette

To access this plug-in in the palette, click Issue Tracking > JIRA Plugin.

Steps

Process steps in the JIRA plug-in

Add Comments

Use this step to add comments from the current changelog to the matching JIRA issues.

Input properties for the Add Comments step
Name Type Description Required
Comment String The template to use for adding a comment to JIRA issues. Yes
Fail Mode Enumeration:

  • WARN_ONLY
  • FAIL_FAST
  • FAIL_ON_NO_UPDATES
The action to take when an unknown issue ID is found. Yes
Issue IDs String A list of issue IDs to update. Separated by commas and/or newline characters. Yes
JIRA Base URL String The URL of the JIRA server. Yes
Password Password The password to use to connect to the JIRA server. No
Password Script String The property or script to use to authenticate with the JIRA server. If this method
is used to authenticate with the server, leave the Password property blank.
No
Proxy Hostname String The hostname to be specified if connecting through http proxy. No
Proxy Port String The port number to be specified if connecting through http proxy. No
Trust All Certificates Boolean Select this option to allow insecure connections to the server. No
User Name String The user name to use to connect to the JIRA server. No

Check Status

Check JIRA Issues

Input properties for the Check Status step
Name Type Description Required
Fail Mode Enumeration:

  • WARN_ONLY
  • FAIL_FAST
  • FAIL_ON_NO_UPDATES
  • FAIL_ON_ANY_FAILURE
The action to take when an issue ID cannot be found. Yes
Issue IDs String A list of issue IDs to check. Separated by commas and/or newline characters. Yes
JIRA Base URL String The URL of the JIRA server. Yes
Password Password The password to use to connect to the JIRA server. No
Password Script String The property or script to use to authenticate with the JIRA server. If this method
is used to authenticate with the server, leave the Password property blank.
No
Proxy Hostname String The hostname to be specified if connecting through http proxy. No
Proxy Port String The port number to be specified if connecting through http proxy. No
Status Name String The expected status of the issue. Yes
Trust All Certificates Boolean Select this option to allow insecure connections to the server. No
User Name String The user name to use to connect to the JIRA server. No

Create Issue

Use this step to create a new issue in a JIRA Bug Tracker.

Input properties for the Create Issue step
Name Type Description Required
Assignee String The assignee for the new issue. If there is no value for this property, the assignee
uses the JIRA automatic assignment.
No
Components String Components for the new issue. Separated by commas and/or newline characters. No
Custom Fields String A JSON object used to set custom field values on the JIRA issue. If standard field
names are used here, they will be silently ignored. See https://docs.atlassian.com/jira/REST/latest/
for syntax.
No
Environment String The environment for this issue. No
Fix Versions String Fix versions for the new issue. Separated by commas and/or newline characters. No
Issue Description String The description of this issue. No
Issue Type String The name of the issue type to create. Yes
JIRA Base URL String The URL of the JIRA server. Yes
Labels String Labels for the new issue. Separated by commas and/or newline characters. No
Parent Issue ID String The issue ID of the parent issue. Overrides environment if entered, ignored if empty. No
Password Password The password to use to connect to the JIRA server. No
Password Script String The property or script to use to authenticate with the JIRA server. If this method
is used to authenicate with the server, leave the Password field blank.
No
Priority String The priority of the created issue. All values are predefined JIRA priority names. Yes
Project Key String The project key in JIRA. Yes
Proxy Hostname String The hostname to be specified if connecting through http proxy. No
Proxy Port String The port number to be specified if connecting through http proxy. No
Summary String The summary for this issue. Yes
Trust All Certificates Boolean Select this option to allow insecure connections to the server. No
User Name String The user name to use to connect to the JIRA server. No

Edit Issue

Use this step to edit fields on an existing JIRA issue.

Input properties for the Edit Issue step
Name Type Description Required
Components String Components to be added to the issue. Separated by commas and/or newline characters. No
Custom Fields String A JSON object used to set custom field values on the JIRA issue. If standard field
names are used here, they will be silently ignored. See https://docs.atlassian.com/jira/REST/latest/
for syntax.
No
Fail Mode Enumeration:

  • WARN_ONLY
  • FAIL_FAST
  • FAIL_ON_NO_UPDATES
  • FAIL_ON_ANY_FAILURE
The action to perform when an unknown issue ID is found. Yes
Fix Versions String Fix versions to be added to the issue. Separated by commas and/or newline characters. No
Issue IDs String A list of issue IDs to edit. Separated by commas and/or newline characters. Yes
JIRA Base URL String The URL of the JIRA server. Yes
Password Password The password to use to connect to the JIRA server. No
Password Script String The property or script to use to authenticate with the JIRA server. If this method
is used to authenicate with the server, leave the Password field blank.
No
Proxy Hostname String The hostname to be specified if connecting through http proxy. No
Proxy Port String The port number to be specified if connecting through http proxy. No
Trust All Certificates Boolean Select this option to allow insecure connections to the server. No
User Name String The user name to use to connect to the JIRA server. No

Transition Issue

Use this step to perform JIRA issue transitions.

Input properties for the Transition Issue step
Name Type Description Required
Additional Comment String Comments to add to the issue when it is updated. Leave the field blank to exclude
comments. You can use scripts in this field.
No
Custom Fields String A JSON object used to set custom field values on the JIRA issue during transition.
If standard field names are used here, they will be silently ignored. See https://docs.atlassian.com/jira/REST/latest/
for syntax.
No
Fail Mode Enumeration:

  • WARN_ONLY
  • FAIL_FAST
  • FAIL_ON_NO_UPDATES
  • FAIL_ON_ANY_FAILURE
The action to perform when an unknown issue ID is found. Yes
Issue IDs String A list of issue IDs. Separated by commas and/or newline characters. Yes
JIRA Base URL String The URL of the JIRA server. Yes
Password Password The password to use to connect to the JIRA server. No
Password Script String The property or script to use to authenticate with the JIRA server. If this method
is used to authenticate with the server, leave the Password attribute blank.
No
Proxy Hostname String The hostname to be specified if connecting through http proxy. No
Proxy Port String The port number to be specified if connecting through http proxy. No
Resolution Name String The resolution which the action has caused. For example, Fixed or Cannot Reproduce.
This property is applicable only when the value for the Action Name property is Resolve
Issue or Close Issue.
No
Transition Name String The transition action to perform upon the issues. For example, Resolve Issue or Close
Issue.
Yes
Trust All Certificates Boolean Select this option to allow insecure connections to the server. No
User Name String The user name to use to connect to the JIRA server. No