feat: add possibility of adding exemptions to the compatibility check.

aws · Jul 1, 2019 · 0313a2a · 0313a2a
1 parent 8eefe5e
commit 0313a2a
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/packages/@aws-cdk/app-delivery/allowed-breaking-changes-0.36.1.txt b/packages/@aws-cdk/app-delivery/allowed-breaking-changes-0.36.1.txt
@@ -0,0 +1 @@
+incompatible-argument:@aws-cdk/app-delivery.PipelineDeployStackAction.bind
diff --git a/packages/@aws-cdk/aws-codepipeline-actions/allowed-breaking-changes-0.36.1.txt b/packages/@aws-cdk/aws-codepipeline-actions/allowed-breaking-changes-0.36.1.txt
@@ -0,0 +1,18 @@
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.Action.bind
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.Action.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.AlexaSkillDeployAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CodeDeployServerDeployAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CloudFormationCreateReplaceChangeSetAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CloudFormationCreateUpdateStackAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CloudFormationDeleteStackAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CloudFormationExecuteChangeSetAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CodeBuildAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.CodeCommitSourceAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.EcrSourceAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.EcsDeployAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.GitHubSourceAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.JenkinsAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.LambdaInvokeAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.ManualApprovalAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.S3DeployAction.bound
+incompatible-argument:@aws-cdk/aws-codepipeline-actions.S3SourceAction.bound
diff --git a/packages/@aws-cdk/aws-codepipeline/allowed-breaking-changes-0.36.1.txt b/packages/@aws-cdk/aws-codepipeline/allowed-breaking-changes-0.36.1.txt
@@ -0,0 +1,2 @@
+incompatible-argument:@aws-cdk/aws-codepipeline.IAction.bind
+removed:@aws-cdk/aws-codepipeline.IPipeline.artifactBucket
diff --git a/scripts/check-api-compatibility.sh b/scripts/check-api-compatibility.sh
@@ -44,12 +44,16 @@ fi
 
 #----------------------------------------------------------------------
 
+# get the current version from Lerna
+current_version=$(npx lerna ls -pl | head -n 1 | cut -d ':' -f 3)
+
 echo "Checking compatibility..." >&2
 success=true
 for i in ${!package_dirs[*]}; do
     if [[ ! -d $tmpdir/node_modules/${package_names[$i]} ]]; then continue; fi
     echo -n "${package_names[$i]}... "
-    if npx jsii-diff --experimental-errors $tmpdir/node_modules/${package_names[$i]} ${package_dirs[$i]} 2>$tmpdir/output.txt; then
+    if npx jsii-diff --experimental-errors $tmpdir/node_modules/${package_names[$i]} ${package_dirs[$i]} \
+            --ignore-file ${package_dirs[$i]}/allowed-breaking-changes-${current_version}.txt 2>$tmpdir/output.txt; then
         echo "OK."
     else
         success=false
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		incompatible-argument:@aws-cdk/app-delivery.PipelineDeployStackAction.bind
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		incompatible-argument:@aws-cdk/aws-codepipeline.IAction.bind
		removed:@aws-cdk/aws-codepipeline.IPipeline.artifactBucket