Release notes 2.0

12 April 2011

Summary

This release has major feature enhancements focused on enabling product integration automation. This is a simultaneous release of all CLI clients. The Atlassian CLI distribution contains all CLI clients plus the atlassian scripts (see below) and additional examples and help text shipped with the distribution.

 

 

Compatibility

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.

Notes

  1. Bamboo 2.7 introduced Stages and Jobs that changed how builds are referenced. This requires some changes and additions to the CLI interface that could not be incorporated in time for the 2.0.0 and maintain compatibility with pre-2.7 releases. A SNAPSHOT with this support is available - see Release notes 2.1.
  2. 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. However, the new APIs will provide some additional capabilities. It will be a while to sort out how the Crowd CLI moves forward in a following release.

Highlights of Atlassian Command Line Interface (CLI) 2.0

Run Actions From A File

A new run action has been added that will run other actions from a file or standard input. Standard input can be the console or a file. This is supported by all CLIs. This has a number of automation benefits:

  1. More efficient for high volume usage scenarios
    • Reduced logins
  2. Avoid command line processing problems with special characters
    • Example - double quote on Windows
  3. Provides another option for automation scripts

Example

atlassian confluence --action run
atlassian confluence --action run < src/itest/resources/run.txt 
atlassian confluence --action run --file "src/itest/resources/run.txt"  
run.txt file
# This is a comment
--action getSpaceList

# Another comment
--action getServerInfo

Run Actions From SQL Queries

A new runFromSql action makes it easy to run multiple actions based on database queries. This is supported by all CLIs. For instance, administrative actions based on product configuration information by accessing the applications database. This requires a JDBC driver appropriate for accessing your database. A PostgreSQL driver is included in the distribution, other databases will require the driver be added manually to the lib/jdbc directory shipped with the distribution.

Example

run.sql file
select '--action addVersion --project ' || pkey || ' --name Z1' from project where pkey like 'ZJIRACLI'
command and output
atlassian jira --action runFromSql --driver postgresql --database jira-4.2.4 --file run.sql

Run: --action addVersion --project ZJIRACLI --name Z1
Version 'Z1' added to project ZJIRACLI

Run completed successfully. 1 actions were successful from file: /Users/bob/run.sql

Atlassian Command Script

A single command script (.bat, .sh) can be customized for use with all product specific CLIs. The shipped script is called atlassian, users are free to rename it for their installation. Advantages include:

  1. Easier to customize a single file
  2. Multiple products and multiple product instances can be covered in a single interface
  3. Handles both interactive (command line) and automation usage with correct error indicator feedback for scripts (Windows)
    • Windows scripts should use the /s option

Other improvements were made in all command scripts including the ability to run the script from the path.

Example

atlassian confluence --action getServerInfo
atlassian.sh jira --action getServerInfo
atlassian jiraTest --action getServerInfo
atlassian /s jira --action getServerInfo 

GINT testing

All CLI clients now have GINT - Groovy Integration Test Framework tests. This improves quality and will significantly reduce time required for release testing and validation against Atlassian product releases. This together with the migration of all source to Mercurial/BitBucket for version control will allow for more frequent development snapshot releases to improve response time for support items or new improvements.

 

Encoding

An encoding parameter is supported for actions involving reading or writing to a file to help users dealing with file encoding needs different than the standard OS encoding.

 

Confluence Command Line Interface (CLI) Improvements

Issues

T Key Summary Reporter Assignee P Status
Loading...
Refresh


JIRA Command Line Interface (CLI) Improvements

Issues

T Key Summary Reporter Assignee P Status
Loading...
Refresh


Bamboo Command Line Interface (CLI) Improvements

Specific Bamboo improvements include artifact and label support including the ability to search with labels. To aid automation of Bamboo build processes with external processes, executeBuild can optionally wait for completion before returning enabling automation to then dependably access current build artifacts and do appropriate build labeling.

Issues

T Key Summary Reporter Assignee P Status
Loading...
Refresh


FishEye Command Line Interface (CLI) Improvements

FishEye now supports common CLI improvements documented above.

Issues

T Key Summary Reporter Assignee P Status
Loading...
Refresh


Crucible Command Line Interface (CLI) Improvements

Crucible now supports common CLI improvements documented above.

Issues

T Key Summary Reporter Assignee P Status
Loading...
Refresh


Crowd Command Line Interface (CLI) Improvements

Crowd now supports common CLI improvements documented above.

Issues

T Key Summary Reporter Assignee P Status
Loading...
Refresh