Special Compatibility Notice for ACLI Version 12.x
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. |
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. |
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 |
---|---|---|---|
jira |
| Existing actions regarding user properties (
If you need to keep the legacy behavior, you need to add | Atlassian does not provide an API to handle UI Manager User Properties, but offers APIs to managed the non-UI managed properties.
Sadly, the term |
jiracloud | Commands using jql to search for issues. | creation and update of issues is asynchronous and a jql search might not instantly reflect the changes in particular after updating large text fields.
If exact JQL results are desired, the customer can specify a list of issue ids to be resolved exactly thanks to a new parameter “ Additionally, in order not to break existing scripts that do an immediate jql search after a write (create or update issue) we introduced a hidden
| In Cloud, the JQL index may not immediately reflect the latest state of issues: this is due to a recent change on Atlassian side. However, you can specify a list of specific IssueIds (referred to as reconcileIssueIds) that will be queried directly, bypassing the JQL index altogether and ensuring precise results for those entries. Our main challenge arises in scenarios where our customers' scripts update an Issue and then promptly query it using JQL expecting immediate retrievals. To prevent breaking existing customer scripts due to these adjustments, we maintain a cache containing “recently updated issue IDs,” which are employed in the “reconcileIssueIds” parameter across all JQL queries—this ensures exact outcomes for those. |
jiracloud | getIssueList | The total number of matches of a JQL query is now an approximation on cloud. This is denoted by | The reason is a change in Atlassian APIs that now are only able to give us back an approximate count of matches. |
confluence and confluencecloud | get and get list actions for spaces, space properties, pages, blogs, comments, attachments and attachment versions. | Major interface changes. Default display output is now simple text output with selected columns deemed most likely to be wanted and quickly retrievable. Specify | Migration to Confluence REST API v2 for Cloud. Atlassian exploded existing endpoints in multiple small ones. This forces ACLI to do many more network calls to get the same amount of information as before. Therefore the list of columns outputted by default has been tailored to a set such that |
confluencecloud | getContentXxx operations | Performance impact. | Migration to Confluence REST API v2 for Cloud. ACLI now needs to separately request details for pages, blogs, attachments and custom contents. We kept backward compatible results by unifying the results from the multiple Atlassian endpoints which has a performance impact. |
confluencecloud | blog related actions | It is not possible anymore to create a blogpost at a specific posting date in the past: every created blog will have a posting date of today. Hence, the date arguments Date arguments made sense to distinguish between pages (no posting date) and blogs (with posting date) and hence those date argument are used to distinguish between pages and blogposts in other commands. For instance, | New Atlassian APIs for Confluence have removed the ability to create blog posts at a specific postingDate: date is always the current day. We had to adapt to keep functionality as close as we could from past behavior. |
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 | 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 getPipeline (only when using | Defaults to most recent items. Equivalent to setting the startDate parameter to -30d or @default. | Improve performance: |
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 |
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 | Design oversight not conforming to standards. |
bitbucketcloud | getDownloadList |
| Clearer indication of what the column means. More consistent with other actions with a created column |
bitbucketcloud | getBranchList | Target prefix removed from commit column headers and other column changes. | Consistency with other actions and avoid confusion. |
bitbucketcloud | getUserList | User field no longer represents the deprecated Bitbucket cloud user name for older users. It is now consistently the nickname for all users. | Bitbucket deprecated the old usage for username even though it is still around for some compatibility things. It is confusing, so we settled on what Bitbucket recommends going forward. |
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 |
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