Description

We always are sensitive to upward compatibility of our offerings and specifically want to make sure CLI scripts are as upward compatible as possible at least with the respect to those aspects that are under our control. Most of our actions remain compatible across a wide range of application releases and even to high degree across different environments (Cloud and Data Center). However, on a CLI version boundary, we do take the opportunity to remove previously deprecated support or make some changes especially where it will simplify new user experiences and remove clutter for users.

This page describes some of the important changes to be aware of when upgrading to 12.x from 11.x or earlier. If upgrading from release prior to 11.x, see also Special Compatibility Notice for ACLI Version 11.x.

Client Changes

Client	Change	Replacement	Discussion
bamboo	removed	bitbucketcloud Continue to use ACLI release 11.3	The bamboo client was deprecated in ACLI release 11.2 and now is being removed from the distribution. This was a difficult decision for us. We started supporting Bamboo in 2007 and it one of our largest clients with over 200 actions. Internally, we have used Bamboo extensively over the years. In late 2021, we started our migration to Bitbucket Pipelines. ACLI products completed migration a few months later and other Appfire apps followed. Bamboo 9.x is still in use by some Appfire products. With the Feb 2024 discontinuance notice for Bamboo Server by Atlassian, we supported customer migration to Bamboo Data Center in ACLI release 11.0 so that Bamboo customers will still be supported by ACLI with ACLI release 11.3 for some time running against Bamboo Data Center 9.2 (LTS) - 9.5. However, Bamboo 9.5 will be the last officially supported release as we have discontinued testing for Bamboo releases and removing the bamboo client starting with ACLI release 12.0. Over the last years, we have invested significantly in the Bitbucket Cloud client and especially the pipeline support to enable customers using Bitbucket Cloud and especially those customer with Bamboo migration efforts.
jsm	removed	Continue to use ACLI release 11.3	The jsm client was deprecated in ACLI release 11.2 and now is being removed from the distribution. Jira Service Management customers can continue to use the Jira client for accessing Jira information in JSM instances just like before, but we are no longer supporting JSM specific actions.
tempo	removed	Continue to use ACLI release 11.3	The tempo client was deprecated in ACLI release 11.1 and now is being removed from the distribution. We were unable to provide meaningful and credible coverage of Tempo capabilities, so we have decided to discontinue the limited support we had. Our existing support in the Jira client for some Tempo custom fields will continue as normal.
trello	removed	Continue to use ACLI release 11.3	The trello client was deprecated in ACLI release 11.1 and now is being removed from the distribution. Low customer interest. We were unable to continue to extend our coverage of Trello capabilities, so we have decided to discontinue the support.
segment	removed	Continue to use ACLI release 11.3	The segment client was deprecated in ACLI release 11.1 and now is being removed from the distribution. Low customer interest.
keen	removed	Continue to use ACLI release 11.3	The keen client was deprecated in ACLI release 11.1 and now is being removed from the distribution. Low customer interest.

Changed Action Behavior

Clients	Action	Change	Reason
bitbucketcloud	get and get list actions	Major interface and performance improvements. Default display output is now simple text output with selected columns deemed most likely to be wanted and quickly retrievable. Specify `--outputFormat 1` to get previous default behavior with CSV output. Specific `columns` and `outputType` can be specified easily to customize view. Script writers are encouraged to specify exact columns needed for their script to isolate the scripts from changes and to optimize performance.	Easier to view data in text table format on reasonably sized terminal. New column selection capability makes easy to customize reports. Performance is much better if certain columns are avoided when they are not needed.
bitbucketcloud	getCommitList, runFromCommitList getDeploymentList, runFromDeploymentList getPipelineList, runFromPipelineList, getCommit (only when using `--commit @last` and other filtering parameters) getPipeline (only when using `--pipeline @last` and other filtering parameters)	Defaults to most recent items. Equivalent to setting the startDate parameter to -30d or @default.	Improve performance: Commits, deployments, and pipelines are continuously being added and can easily grow to a large number of items. Unless a limit parameter is provided, the entire list might have to be evaluated to produce the desired list. Limiting by default prevents accidental long running requests. Use `--startDate @all` to avoid the default or specify a specific startDate based on your needs.
bitbucketcloud	getBranchList, getBranch (name search) getPullRequest, getPullRequest (name search)	Defaults to most recent items. Equivalent to setting the startDate parameter to -365d or @default.	Similar to above.
bitbucketcloud	getPullRequestList column order		Having the author fields before the pull request field did not follow standards. Script writers are now encouraged with 12.0 to explicitly list the columns they need in the order they want in the `columns` parameter to best protect the script from future changes.

Removed Actions

Clients	Removed	Replacement	Discussion
cli	provideFeedback		This was done through a Keen service no longer available

Removed Parameters

Clients	Removed	Replacement	Discussion

Changed Output Formats

Clients	Action	Change	Reason
bitbucketcloud	getPullRequestList	The author columns were moved after the merge commit column on all output formats. Scripts can specify column order explicitly using the `columns` parameter to get previous behavior.	Design oversight not conforming to standards.

Deprecated Actions

This is a notice that we have deprecated some actions so you can start migrating any scripts to the new support over time. It is likely these will be removed in a later version. This was part of an ongoing effort to simplify some usage scenarios and prune our interfaces to avoid confusion.

Clients	Deprecated	First Deprecated	Replacement	Discussion
jira	addFieldConfigurationScheme, addIssueTypeScreenScheme, addScreenScheme	11.0	createFieldConfigurationScheme, createIssueTypeScreenScheme, createScreenScheme	consistency across scheme actions
cli, csv, web	renderRequest	11.0	webRequest
bitbucketcloud	getSource	12.0	getFile	Both source and binary file data can be retrieved, so `getFile` is more appropriate terminology.
bitbucket	addBranch, removeBranch	10.6	createBranch, deleteBranch	consistency with bitbucketcloud client and general use verbage
jira	deleteComponent	10.4	removeComponent	consistency with addComponent
marketplace	getAppReviewList	10.x	getReviewList	simplification
confluence	getPageHistoryList, removePageVersion	10.x	getContentHistoryList, removeContentVersion	broader support with the content action

Deprecated Parameters

This is a notice that we have deprecated some parameters so you can start migrating any scripts to the new support over time. It is likely these will be removed in a later version. This was part of an ongoing effort to simplify some usage scenarios and prune our interfaces to avoid confusion.

Clients	Deprecated	First Deprecated	Replacement	Discussion
agile	id	10.x	board	board parameter can be used for board name or id
jira	values, value2	10.x	field	field parameter can be used multiple times and includes field name and value
jira	field2	10.x	field	field parameter can be used multiple times and includes field name and value
slack	autowait	10.x		now automatically done
all	host	10.x	url	Specify host as part of the url parameter for database access. ACLI-2164 and ACLI-1897
all	port	10.x	url	Specify port as part of the url parameter for database access. ACLI-2164 and ACLI-1897
jira, confluence, bitbucket	targetPassword, targetToken, targetUser	10.x		Use targetServer referencing a ACLI configuration entry to specify this information.

Deprecated Environment Variables

none

Special Compatibility Notice for ACLI Version 12.x

Work in progress