We're updating the issue view to help you get more done. 

Improve single action help output

Description

Single action help is produced when --help is requested when an action has been specified. Description, required and optional parameters, output formats, and replacement variables are provided when appropriate. Previously, this was in text. With this improvement, the same information and more will be provided in table format. Relates to and ACLI-746.

Additional information has been added including:

  • Common parameters - global parameters that are optional for most actions or actions in a related group of actions

  • Database parameters - global parameters that apply to all get list actions when output format is CSV

Example 1

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 -a runFromIssueList --help ┌─────────────┬────────────────────────────────────────────────────────────────┐ │ Action │ runFromIssueList │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Description │ Run actions for each issue from an issue list based on a jql │ │ │ search. │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Required │ jql or project │ │ parameters │ │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Optional │ limit, common, input, continue, simulate, file, encoding, │ │ parameters │ clearFileBeforeAppend, findReplace, findReplaceRegex │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Common │ help, verbose, debug, quiet, special, dateFormat, dateFormat2, │ │ parameters │ outputType │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Replacement │ issue, issueId, issueUrl, project, projectId, parent, │ │ variables │ parentId, parentUrl │ └─────────────┴────────────────────────────────────────────────────────────────┘

Example 2

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 -a getProjectList --help ┌─────────────┬────────────────────────────────────────────────────────────────┐ │ Action │ getProjectList │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Description │ List defined projects with optional filtering by lead, │ │ │ category, and regex on project key. Get projects with no │ │ │ category by setting the category parameter to blank. │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Optional │ lead, category, regex, outputFormat, file, columns, encoding │ │ parameters │ │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Common │ help, verbose, debug, quiet, special, dateFormat, dateFormat2, │ │ parameters │ outputType │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Database │ url, dbUser, dbPassword, database, driver, host, port, │ │ parameters │ propertyFile │ ├─────────────┼────────────────────────────────────────────────────────────────┤ │ Output │ 1 - default, 2 - issue count and category, 999 - all │ │ formats │ │ └─────────────┴────────────────────────────────────────────────────────────────┘

Environment

None

Status

Assignee

Bob Swift [Bob Swift Atlassian Apps]

Reporter

Bob Swift [Bob Swift Atlassian Apps]

Labels

None

Support Entitlement

None

Fix versions

Priority

Major