Skip to content

Commit

Permalink
chore(cli): clarify the intent of notices (#22228)
Browse files Browse the repository at this point in the history
We've recently seen lots of [confusion](#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*
  • Loading branch information
iliapolo committed Nov 30, 2022
1 parent 2eb7d73 commit d6ede1a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion packages/aws-cdk/lib/notices.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 <id>". For example, "cdk acknowledge ${exampleNumber}".`,
].join('\n\n');
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk/test/notices.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d6ede1a

Please sign in to comment.