Skip to content
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.

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

chore: add @InternalSdkApi to binary compatibility checks; introduce new PR check to verify no API-breaking changes #1204

Merged
merged 1 commit into from
Feb 6, 2024

Conversation

ianbotsf
Copy link
Contributor

@ianbotsf ianbotsf commented Feb 6, 2024

Issue #

Resolves #1191

Description of changes

Same as smithy-lang/smithy-kotlin#1030 but for aws-sdk-kotlin:

  • Removing @InternalSdkApi from the exemptions for the backwards compatibility verifier
    • Also updates the API dumps because a lot of previously-exempted APIs are now in scope
  • Adds a PR check which verifies that either no API dump lines have been deleted or the acknowledge-api-break label is applied to the PR

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

…new PR check to verify no API-breaking changes
@ianbotsf ianbotsf added the no-changelog Indicates that a changelog entry isn't required for a pull request. Use sparingly. label Feb 6, 2024
@ianbotsf ianbotsf requested a review from a team as a code owner February 6, 2024 19:24
Copy link

sonarcloud bot commented Feb 6, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link

github-actions bot commented Feb 6, 2024

A new generated diff is ready to view.

  • No codegen difference in the AWS SDK

branches: [ main ]

jobs:
api-compat-verification:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: We could move this to workflow to aws-kotlin-repo-tools and share it across repos. It's not a lot of code and not likely to change often but something to consider if we do end up having to make changes to each repo over time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but I'd rather do that in a separate effort. I think a few of our GH workflows are candidates for consolidation which would warrant a new PR.

@ianbotsf ianbotsf merged commit 7beac10 into main Feb 6, 2024
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Indicates that a changelog entry isn't required for a pull request. Use sparingly.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Strengthen backwards-compatibility CI checks
4 participants