diff --git a/.github/scripts/backwards_compatibility_check.sh b/.github/scripts/backwards_compatibility_check.sh index 03eee014..44179897 100755 --- a/.github/scripts/backwards_compatibility_check.sh +++ b/.github/scripts/backwards_compatibility_check.sh @@ -92,7 +92,7 @@ find_removed_methods() { grep -v 'software\.amazon\.kinesis\.retrieval\.kpl\.Messages') for class in $latest_classes do - if (is_kinesis_client_internal_api "$class" && (is_new_minor_release || is_new_major_release)) || is_non_public_class "$class" + if is_kinesis_client_internal_api "$class" || is_non_public_class "$class" then continue fi @@ -117,10 +117,6 @@ find_removed_methods() { if [[ "$removed_methods" != "" ]] then REMOVED_METHODS_FLAG=$TRUE - if is_kinesis_client_internal_api "$class" - then - echo "Found removed methods in class with @KinesisClientInternalApi annotation. To resolve these issues, upgrade the current minor version or address these changes." - fi echo "$class does not have method(s):" echo "$removed_methods" fi diff --git a/amazon-kinesis-client/src/main/java/software/amazon/kinesis/annotations/KinesisClientInternalApi.java b/amazon-kinesis-client/src/main/java/software/amazon/kinesis/annotations/KinesisClientInternalApi.java index e10583e8..37fb79ab 100644 --- a/amazon-kinesis-client/src/main/java/software/amazon/kinesis/annotations/KinesisClientInternalApi.java +++ b/amazon-kinesis-client/src/main/java/software/amazon/kinesis/annotations/KinesisClientInternalApi.java @@ -19,7 +19,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; /** - * Any class/method/variable marked with this annotation is subject to breaking changes between minor releases. + * Marker interface for 'internal' APIs that should not be used outside the core module. + * Breaking changes can and will be introduced to elements marked as KinesisClientInternalApi. + * Users of the KCL should not depend on any packages, types, fields, constructors, or methods with this annotation. */ @Retention(RetentionPolicy.CLASS) public @interface KinesisClientInternalApi {}