From d6ede1a8abe2317cdb4056be029cc3e20e17c073 Mon Sep 17 00:00:00 2001 From: Eli Polonsky Date: Wed, 30 Nov 2022 03:14:14 -0800 Subject: [PATCH] chore(cli): clarify the intent of notices (#22228) We've recently seen lots of [confusion](https://github.com/aws/aws-cdk/issues/21902) from our users thinking the sheer display of the notice constitutes an error. Try to clarify this isn't the case. ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/aws-cdk/lib/notices.ts | 2 +- packages/aws-cdk/test/notices.test.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/aws-cdk/lib/notices.ts b/packages/aws-cdk/lib/notices.ts index 7370b84a36f9f..cfe03a4afcab6 100644 --- a/packages/aws-cdk/lib/notices.ts +++ b/packages/aws-cdk/lib/notices.ts @@ -63,7 +63,7 @@ function dataSourceReference(ignoreCache: boolean): NoticeDataSource { function finalMessage(individualMessages: string[], exampleNumber: number): string { return [ - '\nNOTICES', + '\nNOTICES (What\'s this? https://github.com/aws/aws-cdk/wiki/CLI-Notices)', ...individualMessages, `If you don’t want to see a notice anymore, use "cdk acknowledge ". For example, "cdk acknowledge ${exampleNumber}".`, ].join('\n\n'); diff --git a/packages/aws-cdk/test/notices.test.ts b/packages/aws-cdk/test/notices.test.ts index 8ce0df5f1a080..25eb0538314e7 100644 --- a/packages/aws-cdk/test/notices.test.ts +++ b/packages/aws-cdk/test/notices.test.ts @@ -390,7 +390,7 @@ describe('cli notices', () => { }); expect(result).toEqual(` -NOTICES +NOTICES (What's this? https://github.com/aws/aws-cdk/wiki/CLI-Notices) 16603 Toggling off auto_delete_objects for Bucket empties the bucket