Rename workflow external references to build to allign with our UI concepts

Author: Itai Gendler

lib/interface/cli/commands/root/get.cmd.js

@@ -17,7 +17,7 @@ const get = new Command({
                 '  * pipelines (aka \'pip\')\n' +
                 '  * environments (aka \'env\')\n' +
                 '  * compositions (aka \'com\')\n' +
-                '  * workflows (aka \'wf\')\n' +
+                '  * builds\n' +
                 '  * images (aka \'img\')')
             .example('$0 get contexts', '# List all contexts')
             .example('$0 get contexts context-name', '# List a single context with specified NAME')

lib/interface/cli/commands/workflow/describe.cmd.js

@@ -6,13 +6,12 @@ const { workflow } = require('../../../../logic').api;
 const describeRoot = require('../root/describe.cmd');
 
 const command = new Command({
-    command: 'workflow <id>',
-    aliases: ['wf'],
-    description: 'Describe a workflow',
+    command: 'build <id>',
+    description: 'Describe a build',
     builder: (yargs) => {
         return yargs
             .positional('id', {
-                describe: 'workflow id',
+                describe: 'build id',
             });
     },
     handler: async (argv) => {

lib/interface/cli/commands/workflow/get.cmd.js

@@ -9,13 +9,13 @@ const getRoot = require('../root/get.cmd');
 const { printError } = require('../../helpers/general');
 
 const command = new Command({
-    command: 'workflows [id]',
-    aliases: ['wf', 'workflow'],
-    description: 'Get workflows',
+    command: 'builds [id]',
+    aliases: ['build'],
+    description: 'Get builds',
     builder: (yargs) => {
         return yargs
             .positional('id', {
-                describe: 'workflow id',
+                describe: 'Build id',
             })
             .option('limit', {
                 describe: 'Limit amount of returned results',
@@ -72,7 +72,7 @@ const command = new Command({
                         pipelineIds.push(currPipeline.info.id);
                     });
                 } else if (_.isEmpty(pipelineIds)) {
-                    throw new CFError('Cannot find any workflows with these pipelines names');
+                    throw new CFError('Cannot find any builds with these pipelines names');
                 }
             }
             workflows = await workflow.getWorkflows({

lib/interface/cli/commands/workflow/logs.cmd.js

@@ -8,14 +8,14 @@ const { log } = require('../../../../logic').api;
 const run = new Command({
     root: true,
     command: 'logs <id>',
-    description: 'Show logs of a workflow',
+    description: 'Show logs of a build',
     builder: (yargs) => {
         yargs
             .positional('id', {
                 describe: 'Pipeline id',
             })
             .option('f', {
-                describe: 'Continue showing workflow logs until it will finish',
+                describe: 'Continue showing build logs until it will finish',
                 type: 'boolean',
             });
 

lib/interface/cli/commands/workflow/restart.cmd.js

@@ -5,15 +5,15 @@ const { log } = require('../../../../logic').api;
 const restart = new Command({
     root: true,
     command: 'restart <id>',
-    description: 'Restart a workflow by its id',
+    description: 'Restart a build by its id',
     builder: (yargs) => {
         return yargs
             .positional('id', {
-                describe: 'Workflow id',
+                describe: 'Build id',
             })
             .option('detach', {
                 alias: 'd',
-                describe: 'Run workflow and print workflow ID',
+                describe: 'Run build and print workflow ID',
             });
     },
     handler: async (argv) => {

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

@@ -37,7 +37,7 @@ const run = new Command({
                 default: false,
             })
             .option('variable', {
-                describe: 'Set workflow variables',
+                describe: 'Set build variables',
                 default: [],
                 alias: 'v',
             })
@@ -48,13 +48,13 @@ const run = new Command({
             })
             .option('detach', {
                 alias: 'd',
-                describe: 'Run pipeline and print workflow ID',
+                describe: 'Run pipeline and print build ID',
             });
 
         crudFilenameOption(yargs, {
             name: 'variable-file',
             alias: 'var-file',
-            describe: 'Set workflow variables from a file',
+            describe: 'Set build variables from a file',
         });
 
         return yargs;

lib/interface/cli/commands/workflow/terminate.cmd.js

@@ -4,17 +4,17 @@ const { workflow } = require('../../../../logic/index').api;
 const terminate = new Command({
     root: true,
     command: 'terminate <id>',
-    description: 'Terminate a workflow by its id',
+    description: 'Terminate a build by its id',
     builder: (yargs) => {
         return yargs
             .positional('id', {
-                describe: 'Workflow id',
+                describe: 'Build id',
             });
     },
     handler: async (argv) => {
         const workflowId = argv.id;
         await workflow.terminateWorkflowById(workflowId);
-        console.log(`Workflow: ${workflowId} terminated`);
+        console.log(`Build: ${workflowId} terminated`);
     },
 });
 

lib/interface/cli/commands/workflow/wait.cmd.js

@@ -9,11 +9,11 @@ const moment = require('moment');
 const annotate = new Command({
     root: true,
     command: 'wait <id..>',
-    description: 'Wait until a condition will be met on a workflow',
+    description: 'Wait until a condition will be met on a build',
     builder: (yargs) => {
         return yargs
             .option('status', {
-                describe: 'Workflow status',
+                describe: 'Build status',
                 alias: 's',
                 choices: ['pending', 'elected', 'running', 'error', 'success', 'terminating', 'terminated'],
                 required: true,
@@ -28,7 +28,7 @@ const annotate = new Command({
                 default: 30,
             })
             .positional('id', {
-                describe: 'Workflow id',
+                describe: 'Build id',
             });
     },
     handler: async (argv) => {
@@ -39,7 +39,7 @@ const annotate = new Command({
         _.forEach(workflowIds, (workflowId) => {
             if (!ObjectID.isValid(workflowId)) {
                 throw new CFError({
-                    message: `Passed workflow id: ${workflowId} is not valid`,
+                    message: `Passed build id: ${workflowId} is not valid`,
                 });
             }
         });

lib/logic/api/workflow.js

@@ -78,7 +78,7 @@ const waitForStatus = async (workflowId, desiredStatus, timeoutDate, descriptive
         await Promise.delay(5000);
         await waitForStatus(workflowId, desiredStatus, timeoutDate, descriptive);
     } else {
-        console.log(`Workflow: ${workflowId} status: ${desiredStatus} reached`);
+        console.log(`Build: ${workflowId} status: ${desiredStatus} reached`);
     }
 };
 

lib/logic/api/workflow.new.js

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.6.8",
+  "version": "0.6.9",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,