chore(examples/cdk): Unpin CDK CLI in devDependencies of CDK examples #615
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.
Description of your changes
With
aws-cdk
as a devDependency and instructing users to runnpm run cdk deploy -all
it can happen thataws-cdk-lib
stops being compatible. In other words: Pinning the CDK CLI version can lead to issues with the runtime dependency on the CDK library.I ran into this today with
"aws-cdk": "^2.0.0"
and"aws-cdk-lib": "2.14.0"
. Receiving the following error onnpm run cdk deploy -all
:This CDK CLI is not compatible with the CDK library used by your application. Please upgrade the CLI to the latest version. (Cloud assembly schema version mismatch: Maximum schema version supported is 15.0.0, but found 16.0.0)
I believe unpinning (^) the CLI for example projects is reasonable and prevents interested users from running into versioning issues on their first contact with the project.
How to verify this change
'npm run cdk deploy -all' successful
Related issues, RFCs
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.