From 7427d606a568fb4d104c67df65be7bf29633fdea Mon Sep 17 00:00:00 2001 From: Rico Huijbers Date: Thu, 7 Jul 2022 20:15:35 +0200 Subject: [PATCH] doc(cli): point out `cdk watch` limitations (#21033) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/aws-cdk/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index 1a43ed4073371..4fe06d1878abf 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -455,8 +455,9 @@ locally to your terminal. To disable this feature you can pass the `--no-logs` o $ cdk watch --no-logs ``` -**Note**: This command is considered experimental, -and might have breaking changes in the future. +**Note**: This command is considered experimental, and might have breaking changes in the future. +The same limitations apply to to `watch` deployments as do to `--hotswap` deployments. See the +*Hotswap deployments for faster development* section for more information. ### `cdk import` @@ -517,10 +518,10 @@ $ cdk destroy --app='node bin/main.js' MyStackName ### `cdk bootstrap` -Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), that provides an S3 bucket -and ECR reposity that `cdk deploy` will use to store synthesized templates and the related assets, before -triggering a CloudFormation stack update. The name of the deployed stack can be configured using the -`--toolkit-stack-name` argument. The S3 Bucket Public Access Block Configuration can be configured using +Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), that provides an S3 bucket +and ECR reposity that `cdk deploy` will use to store synthesized templates and the related assets, before +triggering a CloudFormation stack update. The name of the deployed stack can be configured using the +`--toolkit-stack-name` argument. The S3 Bucket Public Access Block Configuration can be configured using the `--public-access-block-configuration` argument. ECR uses immutable tags for images. ```console