feat(cli): add a switch to display all stack events

closes #8696

Author: shivlaks

packages/aws-cdk/bin/cdk.ts

@@ -90,12 +90,11 @@ async function parseCommandLineArguments() {
       .option('parameters', { type: 'array', desc: 'Additional parameters passed to CloudFormation at deploy time (STACK:KEY=VALUE)', nargs: 1, requiresArg: true, default: {} })
       .option('outputs-file', { type: 'string', alias: 'O', desc: 'Path to file where stack outputs will be written as JSON', requiresArg: true })
       .option('previous-parameters', { type: 'boolean', default: true, desc: 'Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled)' })
-      .option('trunc', { type: 'boolean', desc: 'Display only stack activity events for the resource currently being updated', default: false}),
+      .option('all-events', { type: 'boolean', desc: 'Display all stack activity events. Default setting displays events for the resource currently being updated', default: false}),
     )
     .command('destroy [STACKS..]', 'Destroy the stack(s) named STACKS', yargs => yargs
       .option('exclusively', { type: 'boolean', alias: 'e', desc: 'Only destroy requested stacks, don\'t include dependees' })
       .option('force', { type: 'boolean', alias: 'f', desc: 'Do not ask for confirmation before destroying the stacks' }))
-    .option('trunc', { type: 'boolean', desc: 'Display only stack activity events for the resource currently being updated', default: false})
     .command('diff [STACKS..]', 'Compares the specified stack with the deployed stack or a local template file, and returns with status 1 if any difference is found', yargs => yargs
       .option('exclusively', { type: 'boolean', alias: 'e', desc: 'Only diff requested stacks, don\'t include dependencies' })
       .option('context-lines', { type: 'number', desc: 'Number of context lines to include in arbitrary JSON diff rendering', default: 3, requiresArg: true })
@@ -281,7 +280,7 @@ async function initCommandLine() {
           parameters: parameterMap,
           usePreviousParameters: args['previous-parameters'],
           outputsFile: args.outputsFile,
-          trunc: args.trunc,
+          allEvents: args.allEvents,
         });
 
       case 'destroy':

packages/aws-cdk/lib/api/cloudformation-deployments.ts

@@ -90,14 +90,14 @@ export interface DeployStackOptions {
   usePreviousParameters?: boolean;
 
   /**
-    * Whether to truncate stack events to display only the
+    * Whether to display all stack events or to display only the events for the
     * resource currently being deployed
     *
     * If not set, the stack history with all stack events will be displayed
     *
     * @default false
     */
-  trunc?: boolean;
+  allEvents?: boolean;
 }
 
 export interface DestroyStackOptions {
@@ -166,7 +166,7 @@ export class CloudFormationDeployments {
       force: options.force,
       parameters: options.parameters,
       usePreviousParameters: options.usePreviousParameters,
-      trunc: options.trunc,
+      allEvents: options.allEvents,
     });
   }
 

packages/aws-cdk/lib/api/deploy-stack.ts

@@ -154,14 +154,14 @@ export interface DeployStackOptions {
   usePreviousParameters?: boolean;
 
   /**
-   * Whether to truncate stack events to display only the
+   * Whether to display all stack events or to display only the events for the
    * resource currently being deployed
    *
    * If not set, the stack history with all stack events will be displayed
    *
    * @default false
    */
-  trunc?: boolean;
+  allEvents?: boolean;
 
   /**
    * Deploy even if the deployed template is identical to the one we are about to deploy.
@@ -270,6 +270,7 @@ export async function deployStack(options: DeployStackOptions): Promise<DeploySt
     // eslint-disable-next-line max-len
     const monitor = options.quiet ? undefined : new StackActivityMonitor(cfn, deployName, stackArtifact, {
       resourcesTotal: (changeSetDescription.Changes ?? []).length,
+      allEvents: options.allEvents,
     }).start();
     debug('Execution of changeset %s on stack %s has started; waiting for the update to complete...', changeSetName, deployName);
     try {

packages/aws-cdk/lib/api/util/cloudformation/stack-activity-monitor.ts

@@ -37,14 +37,14 @@ export interface StackActivityMonitorProps {
   readonly logLevel?: LogLevel;
 
   /**
-   * Whether to truncate stack events to display only the
+   * Whether to display all stack events or to display only the events for the
    * resource currently being deployed
    *
    * If not set, the stack history with all stack events will be displayed
    *
    * @default false
    */
-  trunc?: boolean;
+  allEvents?: boolean;
 }
 
 export class StackActivityMonitor {
@@ -90,9 +90,9 @@ export class StackActivityMonitor {
     const isWindows = process.platform === 'win32';
     const verbose = options.logLevel ?? logLevel;
     const fancyOutputAvailable = !isWindows && stream.isTTY;
-    const trunc = options.trunc ?? false;
+    const allEvents = options.allEvents ?? false;
 
-    this.printer = fancyOutputAvailable && !trunc && !verbose
+    this.printer = fancyOutputAvailable && !allEvents && !verbose
       ? new CurrentActivityPrinter(props)
       : new HistoryActivityPrinter(props);
   }

packages/aws-cdk/lib/cdk-toolkit.ts

@@ -190,7 +190,7 @@ export class CdkToolkit {
           force: options.force,
           parameters: Object.assign({}, parameterMap['*'], parameterMap[stack.stackName]),
           usePreviousParameters: options.usePreviousParameters,
-          trunc: options.trunc,
+          allEvents: options.allEvents,
         });
 
         const message = result.noOp
@@ -580,14 +580,14 @@ export interface DeployOptions {
   usePreviousParameters?: boolean;
 
   /**
-   * Whether to truncate stack events to display only the
+   * Whether to display all stack events or to display only the events for the
    * resource currently being deployed
    *
    * If not set, the stack history with all stack events will be displayed
    *
    * @default false
    */
-  trunc?: boolean;
+  allEvents?: boolean;
 
   /**
    * Path to file where stack outputs will be written after a successful deploy as JSON