feat(core): facility to warn when deprecated APIs are used #9585
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduce `Annotations.addDeprecation()` which will attach a warning to the construct indicating that a deprecated API is used. At the moment, we only use this to warn when `.node` is used instead of `.construct`, but we will gradually use this to report the usage of all deprecated APIs as a preparation for v2.0. If the environment variable `CDK_BLOCK_DEPRECATIONS` is set (and it is set in `cdk-test`), it will cause usage of deprecated APIs to throw an error instead. Related: aws/aws-cdk-rfcs#192
nija-at
suggested changes
Aug 11, 2020
Co-authored-by: Niranjan Jayakar <nija@amazon.com>
eladb
changed the title
eladb
added
the
pr-linter/exempt-readme
nija-at
approved these changes
Aug 11, 2020
added 15 commits
August 11, 2020 14:01
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce
Annotations.addDeprecation()which will attach a warning to the construct indicating that a deprecated API is used.At the moment, we only use this to warn when
.nodeis used instead of.construct, but we will gradually use this to report the usage of all deprecated APIs as a preparation for v2.0.If the environment variable
CDK_BLOCK_DEPRECATIONSis set (and it is set incdk-test), it will cause usage of deprecated APIs to throw an error instead.Related: aws/aws-cdk-rfcs#192
Build will be failing until #9584 is merged
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license