Skip to content

Mixed version compatibility detection #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RanVaknin merged 2 commits into from
Oct 15, 2025
Merged

Mixed version compatibility detection #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47d0582
Fix false positive filtering for block comments
RanVaknin Oct 14, 2025
74eeb2a
Address feedback: show only changed class names in error message
RanVaknin Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/workflows/mixed-version-compatibility-review.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ jobs:
grep '^+.*public.*(' | \
grep -v '^+[[:space:]]*//.*public.*(' | \
grep -v '^+.*".*public.*(' | \
grep -v '^+[[:space:]]*\*.*public.*(' || true)
grep -v '^+[[:space:]]*\*.*public.*(' | \
grep -v '^+[[:space:]]*/\*.*public.*(' || true)

if [ -n "$NEW_METHODS" ]; then
echo "::warning::New public methods detected in base classes:"
Expand All @@ -67,9 +68,20 @@ jobs:
- name: Fail if compatibility risks found without approval
if: ${{ steps.compatibility-check.outputs.has_risk == 'true' && !contains(github.event.pull_request.labels.*.name, 'mixed-version-compatibility-reviewed') }}
run: |
# Define the base class files
BASE_CLASS_FILES="core/aws-core/src/main/java/software/amazon/awssdk/awscore/AwsRequest.java
core/aws-core/src/main/java/software/amazon/awssdk/awscore/AwsResponse.java
core/aws-core/src/main/java/software/amazon/awssdk/awscore/AwsResponseMetadata.java
core/aws-core/src/main/java/software/amazon/awssdk/awscore/exception/AwsServiceException.java
core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkPojo.java"

# Extract class names from the actually changed files
CHANGED_BASE_FILES=$(git diff --name-only remotes/origin/${{ github.base_ref }} -- $BASE_CLASS_FILES || true)
CHANGED_CLASS_NAMES=$(echo "$CHANGED_BASE_FILES" | sed 's|.*/||' | sed 's|\.java||' | paste -sd ',' - | sed 's/,/, /g')

echo "::error::Mixed version compatibility risk detected!"
echo "::error::Changes were made to base classes that generated service code implements:"
echo "::error::- AwsRequest, AwsResponse, AwsResponseMetadata, AwsServiceException, SdkPojo"
echo "::error::- $CHANGED_CLASS_NAMES"
echo "::error::"
echo "::error::This may break customers using mixed SDK versions if:"
echo "::error::- New methods are added with UnsupportedOperationException defaults"
Expand Down
Loading