cdk icon indicating copy to clipboard operation
cdk copied to clipboard

chore: Specify minimum `aws-cdk` version in peerDependencies instead of a specific version

Open AshCorr opened this issue 8 months ago • 2 comments

What does this change?

We often get Dependabot PRs on our repos that try to update our version of aws-cdk before a new version of @guardian/cdk has been released, its quite annoying to have to wait till a new version of @guardian/cdk is released just to make a minor version update. Particularly as we group Dependabot PRs together causing us to have to manually remove the aws-cdk bumps from the group PR.


This pull request specifies a minimum aws-cdk version in peerDependencies instead of tagging a specific version. This is as per AWS's own recommendation here:

To make sure your library is compatible with the widest range of CDK versions: pick the minimum aws-cdk-lib version that your library requires; declare a range dependency with a caret on that version in peerDependencies, and declare a point version dependency on that version in devDependencies.

In practice we use Snapshot testing in most of our CDK projects meaning any compatability issues should be flagged by either failing snapshots or failing CI.

AshCorr avatar Apr 07 '25 15:04 AshCorr

🦋 Changeset detected

Latest commit: 2c2fcd46ffe61969838cbe230ef4c70fcda204f9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@guardian/cdk Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar Apr 07 '25 15:04 changeset-bot[bot]

This PR is stale because it has been open 30 days with no activity. Unless a comment is added or the “stale” label removed, this will be closed in 3 days

github-actions[bot] avatar May 12 '25 06:05 github-actions[bot]

This PR was closed because it has been stalled for 3 days with no activity.

github-actions[bot] avatar May 19 '25 06:05 github-actions[bot]