Skip to content

Commit c8cdec6

Browse files
authored
docs(cli): document what --unstable means for cdk gc (#32013)
Minor updates to how `cdk gc` is presented in docs, specifically with regards to the `--unstable` flag. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 6190c14 commit c8cdec6

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

packages/aws-cdk/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -895,7 +895,10 @@ cdk bootstrap --no-previous-parameters
895895
CDK Garbage Collection.
896896

897897
> [!CAUTION]
898-
> CDK Garbage Collection is under development and therefore must be opted in via the `--unstable` flag: `cdk gc --unstable=gc`.
898+
> CDK Garbage Collection is under development and therefore must be opted in via the
899+
>`--unstable` flag: `cdk gc --unstable=gc`. `--unstable` indicates that the scope and
900+
> API of feature might still change. Otherwise the feature is generally production
901+
> ready and fully supported.
899902
900903
`cdk gc` garbage collects unused assets from your bootstrap bucket via the following mechanism:
901904

packages/aws-cdk/lib/cli.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ async function parseCommandLineArguments(args: string[]) {
115115
.option('template', { type: 'string', requiresArg: true, desc: 'Use the template from the given file instead of the built-in one (use --show-template to obtain an example)' })
116116
.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)' }),
117117
)
118-
.command('gc [ENVIRONMENTS..]', 'Garbage collect assets', (yargs: Argv) => yargs
118+
.command('gc [ENVIRONMENTS..]', 'Garbage collect assets. Options detailed here: https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/README.md#cdk-gc', (yargs: Argv) => yargs
119119
.option('action', { type: 'string', desc: 'The action (or sub-action) you want to perform. Valid entires are "print", "tag", "delete-tagged", "full".', default: 'full' })
120120
.option('type', { type: 'string', desc: 'Specify either ecr, s3, or all', default: 'all' })
121121
.option('rollback-buffer-days', { type: 'number', desc: 'Delete assets that have been marked as isolated for this many days', default: 0 })

0 commit comments

Comments
 (0)