fix doc and add support for commit id (#191)

Author: ziv-codefresh

lib/interface/cli/Command.js

@@ -231,11 +231,7 @@ class Command {
             }
             let aliases = '';
             if (option.value.alias) {
-                let aliasString = '';
-                _.forEach(option.value.alias, (alias) => {
-                    aliasString += `- ${alias}`;
-                });
-                aliases += aliasString;
+                aliases += `- ${option.value.alias}`;
             }
             const defaultValue = option.value.default || '';
             res.options[group] += `--${key} | ${aliases} | ${defaultValue} | ${description}\n`;

lib/interface/cli/commands/pipeline/run.cmd.js

@@ -11,7 +11,7 @@ const authManager = require('../../../../logic').auth.manager;
 const run = new Command({
     root: true,
     command: 'run <name>',
-    description: 'Run a pipeline and attach the created workflow logs.',
+    description: 'Run a pipeline by id or name and attach the created workflow logs.',
     usage: 'Returns an exit code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2)',
     webDocs: {
         category: 'Pipelines',
@@ -55,11 +55,11 @@ const run = new Command({
                 describe: 'Run pipeline with contexts',
                 default: [],
             })
-            .example('codefresh run PIPELINE_ID -b=master', 'Defining the source control context using a branch')
-            .example('codefresh run PIPELINE_ID -s=52b992e783d2f84dd0123c70ac8623b4f0f938d1', 'Defining the source control context using a commit')
-            .example('codefresh run PIPELINE_ID -b=master -v key1=value1 -v key2=value2', 'Setting variables through the command')
-            .example('codefresh run PIPELINE_ID -b=master --var-file ./var_file.yml', 'Settings variables through a yml file')
-            .example('codefresh run PIPELINE_ID -b=master --context context', 'Inject contexts to the pipeline execution');
+            .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master', 'Defining the source control context using a branch')
+            .example('codefresh run PIPELINE_ID | PIPELINE_NAME -s=52b992e783d2f84dd0123c70ac8623b4f0f938d1', 'Defining the source control context using a commit')
+            .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master -v key1=value1 -v key2=value2', 'Setting variables through the command')
+            .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master --var-file ./var_file.yml', 'Settings variables through a yml file')
+            .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master --context context', 'Inject contexts to the pipeline execution');
 
         crudFilenameOption(yargs, {
             name: 'variable-file',

lib/logic/api/workflow.js

@@ -25,6 +25,7 @@ const _extractFieldsForWorkflowEntity = (workflow) => {
         trigger: workflow.trigger,
         progress: workflow.progress,
         'pipeline-Id': workflow.serviceId,
+        'commit-Id': workflow.revision,
     };
 };
 

lib/logic/entities/Workflow.js

@@ -17,6 +17,7 @@ class Workflow extends Entity {
             'trigger',
             'repository',
             'branch',
+            'commit-Id',
         ];
     }