fix(cli): deprecate "bootstrap-stack-name" in favor of "toolkit-stack-name" for gc command (#795)

Fixes #385

Elsewhere we are consistently naming this property `toolkit-stack-name`,
so this PR aligns `gc` with the rest of the CLI world. We may have
better options here, like making `toolkit-stack-name` a global option,
but this is an easy fix for now.

Does not break users by maintaining `bootstrap-stack-name` as an alias
of `toolkit-stack-name` for `gc`. However `bootstrap-stack-name` is
marked as deprecated and will be removed when we GA garbage collection.

---
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license

Author: kaizencc

packages/aws-cdk/lib/cli/cli-config.ts

@@ -110,7 +110,8 @@ export async function makeConfig(): Promise<CliConfig> {
           'rollback-buffer-days': { type: 'number', desc: 'Delete assets that have been marked as isolated for this many days', default: 0 },
           'created-buffer-days': { type: 'number', desc: 'Never delete assets younger than this (in days)', default: 1 },
           'confirm': { type: 'boolean', desc: 'Confirm via manual prompt before deletion', default: true },
-          'bootstrap-stack-name': { type: 'string', desc: 'The name of the CDK toolkit stack, if different from the default "CDKToolkit"', requiresArg: true },
+          'toolkit-stack-name': { type: 'string', desc: 'The name of the CDK toolkit stack, if different from the default "CDKToolkit"', requiresArg: true, conflicts: 'bootstrap-stack-name' },
+          'bootstrap-stack-name': { type: 'string', desc: 'The name of the CDK toolkit stack, if different from the default "CDKToolkit" (deprecated, use --toolkit-stack-name)', deprecated: 'use --toolkit-stack-name', requiresArg: true, conflicts: 'toolkit-stack-name' }, // TODO: remove when garbage collection is GA
         },
       },
       'flags': {

packages/aws-cdk/lib/cli/cli-type-registry.json

@@ -322,10 +322,18 @@
           "desc": "Confirm via manual prompt before deletion",
           "default": true
         },
-        "bootstrap-stack-name": {
+        "toolkit-stack-name": {
           "type": "string",
           "desc": "The name of the CDK toolkit stack, if different from the default \"CDKToolkit\"",
-          "requiresArg": true
+          "requiresArg": true,
+          "conflicts": "bootstrap-stack-name"
+        },
+        "bootstrap-stack-name": {
+          "type": "string",
+          "desc": "The name of the CDK toolkit stack, if different from the default \"CDKToolkit\" (deprecated, use --toolkit-stack-name)",
+          "deprecated": "use --toolkit-stack-name",
+          "requiresArg": true,
+          "conflicts": "toolkit-stack-name"
         }
       }
     },

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

@@ -442,12 +442,15 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
         if (!configuration.settings.get(['unstable']).includes('gc')) {
           throw new ToolkitError('Unstable feature use: \'gc\' is unstable. It must be opted in via \'--unstable\', e.g. \'cdk gc --unstable=gc\'');
         }
+        if (args.bootstrapStackName) {
+          await ioHost.defaults.warn('--bootstrap-stack-name is deprecated and will be removed when gc is GA. Use --toolkit-stack-name.');
+        }
         return cli.garbageCollect(args.ENVIRONMENTS, {
           action: args.action,
           type: args.type,
           rollbackBufferDays: args['rollback-buffer-days'],
           createdBufferDays: args['created-buffer-days'],
-          bootstrapStackName: args.bootstrapStackName,
+          bootstrapStackName: args.toolkitStackName ?? args.bootstrapStackName,
           confirm: args.confirm,
         });
 

packages/aws-cdk/lib/cli/convert-to-user-input.ts

@@ -89,6 +89,7 @@ export function convertYargsToUserInput(args: any): UserInput {
         rollbackBufferDays: args.rollbackBufferDays,
         createdBufferDays: args.createdBufferDays,
         confirm: args.confirm,
+        toolkitStackName: args.toolkitStackName,
         bootstrapStackName: args.bootstrapStackName,
         ENVIRONMENTS: args.ENVIRONMENTS,
       };
@@ -373,6 +374,7 @@ export function convertConfigToUserInput(config: any): UserInput {
     rollbackBufferDays: config.gc?.rollbackBufferDays,
     createdBufferDays: config.gc?.createdBufferDays,
     confirm: config.gc?.confirm,
+    toolkitStackName: config.gc?.toolkitStackName,
     bootstrapStackName: config.gc?.bootstrapStackName,
   };
   const flagsOptions = {

packages/aws-cdk/lib/cli/parse-command-line-arguments.ts

@@ -345,11 +345,20 @@ export function parseCommandLineArguments(args: Array<string>): any {
             type: 'boolean',
             desc: 'Confirm via manual prompt before deletion',
           })
-          .option('bootstrap-stack-name', {
+          .option('toolkit-stack-name', {
             default: undefined,
             type: 'string',
             desc: 'The name of the CDK toolkit stack, if different from the default "CDKToolkit"',
             requiresArg: true,
+            conflicts: 'bootstrap-stack-name',
+          })
+          .option('bootstrap-stack-name', {
+            default: undefined,
+            type: 'string',
+            desc: 'The name of the CDK toolkit stack, if different from the default "CDKToolkit" (deprecated, use --toolkit-stack-name)',
+            deprecated: 'use --toolkit-stack-name',
+            requiresArg: true,
+            conflicts: 'toolkit-stack-name',
           }),
     )
     .command('flags [FLAGNAME..]', 'View and toggle feature flags.', (yargs: Argv) =>

packages/aws-cdk/lib/cli/user-input.ts

@@ -601,6 +601,14 @@ export interface GcOptions {
    *
    * @default - undefined
    */
+  readonly toolkitStackName?: string;
+
+  /**
+   * The name of the CDK toolkit stack, if different from the default "CDKToolkit" (deprecated, use --toolkit-stack-name)
+   *
+   * @deprecated use --toolkit-stack-name
+   * @default - undefined
+   */
   readonly bootstrapStackName?: string;
 
   /**