-
Notifications
You must be signed in to change notification settings - Fork 50
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: API compatibility verification | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [ opened, synchronize, reopened, labeled, unlabeled ] | ||
| branches: [ main ] | ||
|
|
||
| jobs: | ||
| api-compat-verification: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Check for API compatibility | ||
| if: ${{ !contains(github.event.pull_request.labels.*.name, 'acknowledge-api-break') }} | ||
| run: | | ||
| git fetch origin ${{ github.base_ref }} --depth 1 && \ | ||
| git diff remotes/origin/${{ github.base_ref }} --numstat "*.api" | awk ' | ||
| BEGIN { s = 0 } | ||
|
|
||
| # git diff numstat shows lines deleted in field 2, hence sum up field 2 across all items | ||
| { s += $2 } | ||
|
|
||
| # exit with the number of lines deleted as the result code so that `if failure()` works below | ||
| END { exit s } | ||
| ' | ||
| - name: Error message | ||
| if: ${{ failure() }} | ||
| run: | | ||
| echo "::error ::This change modifies the public API in a way that may be backwards-incompatible. Carefully review this pull request and either:" | ||
| echo "::error ::* Revert the changes which caused the API incompatibility –or–" | ||
| echo "::error ::* Add the 'acknowledge-api-break' label to this PR (in rare cases warranting an API breakage)" | ||
| exit 1 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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-toolsand 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.There was a problem hiding this comment.
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.