14 Aug 2011

Summary

This release focused on major functional enhancements to the JIRA Command Line Interface (CLI). This is a simultaneous release of all Command Line Interface (CLI) clients except for the Crowd Command Line Interface (CLI) - see note. The Atlassian Command Line Interface (CLI) distribution contains all CLI clients (except Crowd) plus the atlassian script and additional examples and help text shipped with the distribution.

This release has improved action and parameter documentation - see Documentation for example.

 

 

The Atlassian Command Line Interface (CLI) supports a large range of product releases. The matrix below provides compatibility guidelines based on testing, API compatibility information provided in Atlassian, and community feedback. User's are encourage to help improve compatibility information through discussions and issues. The CLI also works with releases not officially listed here since in many cases it uses remote APIs provided by Atlassian that have been stable for many years. Check previous versions of the CLI for coverage of earlier releases. Users should verify their usage scenarios on new releases. Support normally is limited to minimum releases indicated. Client requires JAVA 1.5 or 1.6 (recommended). In some cases, new actions are only available on against later versions of the server - these are usually noted in the documentation.

Product, Releases, Tested releases
Confluence, (/) 3.1 - 3.5, "3.1.1, 3.4.0, 3.5.0"
JIRA, (/) 4.0 - 4.4 (Note 1 and 2), "4.2.4, 4.3.3, 4.4"
Bamboo, (/) 3.0 - 3.2 (Note 3), "3.0.1, 3.1.4, 3.2"
Crucible, (/) 2.2 - 2.6, "2.2.1, 2.6.3"
Fisheye, (/) 2.2 - 2.6, "2.2.1, 2.6.3"

Notes

  1. JIRA CLI has some new actions and other improvements that are based on JIRA new REST apis. These APIs started being available with JIRA 4.2 and were significantly enhanced in JIRA 4.3 and 4.4. Attempts to use these actions prior to the supporting JIRA release will result in appropriate error messages. Existing functions will still work on releases prior to 4.2, but releases earlier than 4.2 will no longer be automatically tested.
  2. JIRA 4.4 incompatibility bug regarding some custom field handling - see JRA-25034
  3. Bamboo 2.7/3.0 introduced Stages and Jobs that changed how builds are referenced. For instance, job is now required to reference build artifacts. Bamboo 3.0.4 or above is recommended due to BAM-8594.

Highlights of Atlassian Command Line Interface (CLI) 2.2

Major JIRA Command Line Interface (CLI) enhancements

Major new actions provide broader functional coverage. Exploitation of the new REST APIs (JIRA 4.2+). Support for JIRA 4.4.

  1. Copy components and versions with replace option
  2. Update components and versions
  3. Swap components, affected versions, and fixed versions when deleting components and versions
  4. Release a version
  5. Get project, update project, and improved project list
  6. Clone project
  7. Clone issues based on JQL query
  8. Copy role actors
  9. Update user
  10. Security level support for issues
  11. Add watchers

Issues

Common Improvements

Standardizing interfaces is important and this release standardizes CSV output produced by a some actions. Standardizing the output will make it easier to use tools (like EXCEL and Open Office) to view the output. It will also help script parsing when the parsing technique expects more strict CSV conventions than normally allowed or is a simple private technique. Details are in ACLI-32.

Actions available on previous releases that produced CSV output will produce differently formatted results that could affect scripts. Scripts using standard CSV parsing libraries should be good, but more limited private parsing may need to be updated.

Issues

Confluence Command Line Interface (CLI) Improvements

Issues

Crowd Command Line Interface (CLI) temporarily discontinued

Crowd

The Crowd Command Line Interface (CLI) has been temporarily suspended from further development until the APIs are improved. As previously noted, Atlassian completely removed the Crowd remote APIs used for the CLI (sad) starting with Crowd 2.1. New replacement APIs do not cover most of the existing functionality. Atlassian is currently targeting application use cases and not automation capabilities for the Crowd APIs. It will be a while to sort out how the Crowd Command Line Interface (CLI) moves forward, until then, the Crowd Command Line Interface (CLI) has been removed from the distribution.