Skip to content

Commit 73994cf

Browse files
authored
fix(cloudformation-diff): @aws-sdk/client-cloudformation should be a peer dependency (#478)
The function signature of `fullDiff` depends on the `DescribeChangeSetOutput` type from `@aws-sdk/client-cloudformation`. Therefore this package should be a peer dependency, not a dev dependency. Updates the dependency type, and adds the minimal version as a devDep to ensure we stay compatible. I needed to add `0BSD` into the license checker since one of the transitive dependencies use it. It is an approved license. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
1 parent 34950ad commit 73994cf

File tree

14 files changed

+520
-22
lines changed

14 files changed

+520
-22
lines changed

.projenrc.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ function genericCdkProps(props: GenericProps = {}) {
358358
},
359359
typescriptVersion: TYPESCRIPT_VERSION,
360360
checkLicenses: props.private ? undefined : {
361-
allow: ['Apache-2.0', 'MIT', 'ISC', 'BSD-3-Clause'],
361+
allow: ['Apache-2.0', 'MIT', 'ISC', 'BSD-3-Clause', '0BSD'],
362362
},
363363
...props,
364364
} satisfies Partial<yarn.TypeScriptWorkspaceOptions>;
@@ -444,6 +444,12 @@ const cloudFormationDiff = configureProject(
444444
name: '@aws-cdk/cloudformation-diff',
445445
description: 'Utilities to diff CDK stacks against CloudFormation templates',
446446
srcdir: 'lib',
447+
devDeps: [
448+
'fast-check',
449+
],
450+
peerDeps: [
451+
'@aws-sdk/client-cloudformation@^3',
452+
],
447453
deps: [
448454
'@aws-cdk/aws-service-spec',
449455
'@aws-cdk/service-spec-types',
@@ -453,7 +459,6 @@ const cloudFormationDiff = configureProject(
453459
'string-width@^4',
454460
'table@^6',
455461
],
456-
devDeps: ['@aws-sdk/client-cloudformation', 'fast-check'],
457462
// FIXME: this should be a jsii project
458463
// (EDIT: or should it? We're going to bundle it into aws-cdk-lib)
459464
tsconfig: {

packages/@aws-cdk-testing/cli-integ/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/cli-lib-alpha/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/cli-plugin-contract/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/cloud-assembly-schema/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/cloudformation-diff/.projen/deps.json

Lines changed: 5 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/cloudformation-diff/.projen/tasks.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/cloudformation-diff/package.json

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/integ-runner/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk/toolkit-lib/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/aws-cdk/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/cdk-assets/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/cdk/.projen/tasks.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)