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

(cfnspec): Has cfnspec been deprecated/replaced by aws-service-spec? #28301

Closed
frankpengau opened this issue Dec 8, 2023 · 4 comments
Closed
Labels
@aws-cdk/core Related to core CDK functionality bug This issue is a bug. documentation This is a problem with documentation. needs-review p2

Comments

@frankpengau
Copy link
Contributor

Describe the issue

Recently, I've been trying to debug some issues with jest assertions of aws-cdk constructs, when moving from aws-cdk/aws-cdk-lib v2.99.1 to v2.100.0+ , where it no longer detects the base class of the construct that I am trying to extend from (e.g. aws-cdk-lib/aws-route53/RecordTarget, aws-cdk-lib/CustomResource), in order to create my new custom construct (e.g. AutoConfigReccordTarget, AutoConfigCustomResource)

I have noticed that cfnspec in aws-cdk seems to show a README that it has been replaced by aws-service-spec, see here: https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/cfnspec/README.md

Which notes the following:

This package has been replaced by a more modern version.
Please use @aws-cdk/aws-service-spec (source) instead.

Is this documentation accurate? If so, it would be preferable that it has a warn for a deprecation notice, during npm package install?

If not, then can you please inform me of what it would be? As I do see that alpha version packages are still being released as recent as last month: https://www.npmjs.com/package/@aws-cdk/cfnspec?activeTab=versions

Links

https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/cfnspec/README.md

@frankpengau frankpengau added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Dec 8, 2023
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Dec 8, 2023
@frankpengau
Copy link
Contributor Author

The PR in question that seems to have put the README notice up for it: #27858

@khushail khushail added needs-review and removed needs-triage This issue or PR still needs to be triaged. labels Dec 8, 2023
@ashishdhingra ashishdhingra added the bug This issue is a bug. label Mar 14, 2024
@pahud pahud added the @aws-cdk/core Related to core CDK functionality label Apr 11, 2024
@scanlonp scanlonp added the p2 label Apr 22, 2024
@moelasmar moelasmar removed the aws-cdk-lib Related to the aws-cdk-lib package label Aug 28, 2024
@pahud
Copy link
Contributor

pahud commented Oct 23, 2024

Following up this issue - aws-service-spec is now used as the CFN schema source rather than cfnspec. I think relevant document has been updated. Let me know if there's any further concern.

@pahud pahud added the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Oct 23, 2024
@frankpengau
Copy link
Contributor Author

It was a bit unclear at the time, but looks to be that way now.

Thank you for confirming!

I still think deprecation notice would be nice, especially for npm package installs but just a minor suggestion.

Happy to close off the issue.

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Oct 24, 2024
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
@aws-cdk/core Related to core CDK functionality bug This issue is a bug. documentation This is a problem with documentation. needs-review p2
Projects
None yet
Development

No branches or pull requests

6 participants