Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(aws-cdk-lib): strip out deprecated symbols from public API #13815

Merged
merged 3 commits into from
Mar 26, 2021

Conversation

nija-at
Copy link
Contributor

@nija-at nija-at commented Mar 26, 2021

The jsii build the 'aws-cdk-lib' module will now run with the 'strip
deprecated' flag enabled. This ensures that the public API of this
module will contain no deprecated symbols.

This is enabled by a new option configured in the module's
package.json and recognized by cdk-build.

Previous commits - ca391b5 and a872e67 - have removed the majority of
deprecated symbols from public APIs. A few remain that are removed as
part of this change.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@nija-at nija-at requested a review from a team March 26, 2021 11:12
@nija-at nija-at self-assigned this Mar 26, 2021
@gitpod-io
Copy link

gitpod-io bot commented Mar 26, 2021

@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Mar 26, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Mar 26, 2021
@nija-at nija-at added the pr/do-not-merge This PR should not be merged at this time. label Mar 26, 2021
@nija-at
Copy link
Contributor Author

nija-at commented Mar 26, 2021

Needs to run after #13814 for the build to succeed.

Comment on lines +432 to +434
if (!Object.values(cxschema.ContextProvider).includes(report.provider as cxschema.ContextProvider)) {
throw new Error(`Unknown context provider requested in: ${JSON.stringify(report)}`);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As-is, these checks will be removed in v2. Is that intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is only needed because cxapi.MissingContext needs to be converted into cxschema.MissingContext.
Specifically, the provider prop is a string in the former and an enum in the latter.
Hence not required in the new API.

cc @rix0rrr to confirm who introduced the change.

@nija-at nija-at removed the pr/do-not-merge This PR should not be merged at this time. label Mar 26, 2021
@mergify
Copy link
Contributor

mergify bot commented Mar 26, 2021

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).

@mergify mergify bot merged commit 88f2c5a into master Mar 26, 2021
@mergify mergify bot deleted the nija-at/strip-deprecated branch March 26, 2021 14:29
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: e3b79d2
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@@ -33,7 +33,8 @@
"cdk-build": {
"eslint": {
"disable": true
}
},
"stripDeprecated": true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curious why this is not in the jsii config. @RomainMuller?

hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Mar 31, 2021
…#13815)

The jsii build the 'aws-cdk-lib' module will now run with the 'strip
deprecated' flag enabled. This ensures that the public API of this
module will contain no deprecated symbols.

This is enabled by a new option configured in the module's
`package.json` and recognized by `cdk-build`.

Previous commits - ca391b5 and a872e67 - have removed the majority of
deprecated symbols from public APIs. A few remain that are removed as
part of this change.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
…#13815)

The jsii build the 'aws-cdk-lib' module will now run with the 'strip
deprecated' flag enabled. This ensures that the public API of this
module will contain no deprecated symbols.

This is enabled by a new option configured in the module's
`package.json` and recognized by `cdk-build`.

Previous commits - ca391b5 and a872e67 - have removed the majority of
deprecated symbols from public APIs. A few remain that are removed as
part of this change.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aws-cdk-lib Related to the aws-cdk-lib package contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants