fix(help): improve help output. fixes #165

Author: justinedelson

README.md

@@ -104,7 +104,6 @@ $ aio config:set cloudmanager_environmentid 7
 
 # Commands
 <!-- commands -->
-* [`aio cloudmanager`](#aio-cloudmanager)
 * [`aio cloudmanager:current-execution:advance PIPELINEID`](#aio-cloudmanagercurrent-executionadvance-pipelineid)
 * [`aio cloudmanager:current-execution:cancel PIPELINEID`](#aio-cloudmanagercurrent-executioncancel-pipelineid)
 * [`aio cloudmanager:current-execution:get PIPELINEID`](#aio-cloudmanagercurrent-executionget-pipelineid)
@@ -129,57 +128,6 @@ $ aio config:set cloudmanager_environmentid 7
 * [`aio cloudmanager:program:list-environments`](#aio-cloudmanagerprogramlist-environments)
 * [`aio cloudmanager:program:list-pipelines`](#aio-cloudmanagerprogramlist-pipelines)
 
-## `aio cloudmanager`
-
-interact with the Cloud Manager API to list, start, cancel, and inspect pipelines and executions.
-
-```
-USAGE
-  $ aio cloudmanager
-
-OPTIONS
-  -r, --passphrase=passphrase  the passphrase for the private key
-
-EXAMPLES
-  $ aio cloudmanager:list-programs
-  $ aio cloudmanager:list-programs --enabledonly
-  $ aio cloudmanager:program:list-pipelines
-  $ aio cloudmanager:program:list-pipelines --programId=PROGRAM_ID
-  $ aio cloudmanager:pipeline:start-execution PIPELINE_ID
-  $ aio cloudmanager:pipeline:start-execution --programId=PROGRAM_ID PIPELINE_ID
-  $ aio cloudmanager:program:list-current-executions
-  $ aio cloudmanager:program:list-current-executions --programId=PROGRAM_ID
-  $ aio cloudmanager:pipeline:get-current-execution PIPELINE_ID
-  $ aio cloudmanager:pipeline:get-current-execution --programId=PROGRAM_ID PIPELINE_ID
-  $ aio cloudmanager:execution:get-quality-gate-results PIPELINE_ID [codeQuality|security|performance]
-  $ aio cloudmanager:execution:get-quality-gate-results --programId=PROGRAM_ID PIPELINE_ID 
-  [codeQuality|security|performance]
-  $ aio cloudmanager:execution:get-step-details PIPELINE_ID EXECUTION_ID
-  $ aio cloudmanager:execution:get-step-details --programId=PROGRAM_ID PIPELINE_ID EXECUTION_ID
-  $ aio cloudmanager:execution:get-step-log PIPELINE_ID
-  $ aio cloudmanager:execution:get-step-log --programId=PROGRAM_ID PIPELINE_ID 
-  [build|codeQuality|devDeploy|stageDeploy|prodDeploy]
-  $ aio cloudmanager:current-execution:cancel PIPELINE_ID
-  $ aio cloudmanager:current-execution:cancel --programId=PROGRAM_ID PIPELINE_ID
-  $ aio cloudmanager:current-execution:advance PIPELINE_ID
-  $ aio cloudmanager:current-execution:advance --programId=PROGRAM_ID PIPELINE_ID
-  $ aio cloudmanager:pipeline:delete PIPELINE_ID
-  $ aio cloudmanager:pipeline:delete --programId=PROGRAM_ID PIPELINE_ID
-  $ aio cloudmanager:pipeline:update PIPELINE_ID --branch=NEW_BRANCH
-  $ aio cloudmanager:pipeline:update --programId=PROGRAM_ID PIPELINE_ID --branch=NEW_BRANCH
-  $ aio cloudmanager:program:list-environments
-  $ aio cloudmanager:program:list-environments --programId=PROGRAM_ID
-  $ aio cloudmanager:environment:list-available-log-options ENVIRONMENT_ID
-  $ aio cloudmanager:environment:list-available-log-options --programId=PROGRAM_ID ENVIRONMENT_ID
-  $ aio cloudmanager:environment:download-logs ENVIRONMENT_ID SERVICE NAME
-  $ aio cloudmanager:environment:download-logs ENVIRONMENT_ID SERVICE NAME DAYS
-  $ aio cloudmanager:environment:download-logs --programId=PROGRAM_ID ENVIRONMENT_ID SERVICE NAME DAYS
-  $ aio cloudmanager:environment:tail-log ENVIRONMENT_ID SERVICE NAME
-  $ aio cloudmanager:environment:tail-log --programId=PROGRAM_ID ENVIRONMENT_ID SERVICE NAME
-```
-
-_See code: [src/commands/cloudmanager/index.js](https://github.com/adobe/aio-cli-plugin-cloudmanager/blob/0.18.0/src/commands/cloudmanager/index.js)_
-
 ## `aio cloudmanager:current-execution:advance PIPELINEID`
 
 advance current pipeline execution either by overriding a waiting quality gate or advancing the approval step

package.json

@@ -64,6 +64,14 @@
     "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>",
     "hooks": {
       "prerun": "./src/hooks/prerun/environment-id-from-config"
+    },
+    "topics" : {
+      "cloudmanager": { "description": "interact with the Cloud Manager API to interact with programs, pipelines, and environments." },
+      "cloudmanager:current-execution" : { "description" : "commands to work with the current execution for a pipeline" },
+      "cloudmanager:execution" : { "description" : "commands to work with executions for a pipeline" },
+      "cloudmanager:environment" : { "description" : "commands to work with environments" },
+      "cloudmanager:pipeline" : { "description" : "commands to work with pipelines" },
+      "cloudmanager:program" : { "description" : "commands to work with programs" }
     }
   },
   "main": "src/index.js",

src/commands/cloudmanager/index.js

@@ -16,7 +16,6 @@ const StartExecutionCommand = require('./commands/cloudmanager/pipeline/create-e
 const GetCurrentExecution = require('./commands/cloudmanager/current-execution/get')
 const ListCurrentExecutions = require('./commands/cloudmanager/program/list-current-executions')
 const GetQualityGateResults = require('./commands/cloudmanager/execution/get-quality-gate-results')
-const CloudManagerCommand = require('./commands/cloudmanager')
 const CancelCurrentExecution = require('./commands/cloudmanager/current-execution/cancel')
 const AdvanceCurrentExecution = require('./commands/cloudmanager/current-execution/advance')
 const ListEnvironments = require('./commands/cloudmanager/program/list-environments')
@@ -36,7 +35,6 @@ const SetPipelineVariables = require('./commands/cloudmanager/pipeline/set-varia
 const DeleteEnvironment = require('./commands/cloudmanager/environment/delete')
 
 module.exports = {
-  aaa: CloudManagerCommand, // needs to be first alphabetically
   'list-programs': new ListProgramsCommand().listPrograms,
   'list-pipelines': new ListPipelinesCommand().listPipelines,
   'start-execution': new StartExecutionCommand().startExecution,

src/index.js

@@ -23,7 +23,7 @@ function loadCommandNames (manifest) {
 }
 
 test('all commands from 0.15.0 have aliases', async () => {
-  const oldCommandNames = loadCommandNames(require('../data/oclif.manifest.0.15.0.json'))
+  const oldCommandNames = loadCommandNames(require('../data/oclif.manifest.0.15.0.json')).filter(name => name !== 'cloudmanager')
 
   const root = path.resolve('.')
   const thisPlugin = new Config.Plugin({ root, type: 'core', ignoreManifest: true, errorOnManifestCreate: true })