Skip to content

Use SPM API diff checker #572

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

Merged
merged 1 commit into from
Mar 28, 2022
Merged

Use SPM API diff checker #572

merged 1 commit into from
Mar 28, 2022

Conversation

FranzBusch
Copy link
Collaborator

Motivation:

SPM has built in functionality to check the API of modules against a target git treeish. We can use this to simplify our check_no_api_breakages.sh script. Closes apple/swift-nio#1239

Modifications:

This PR, exchanges the direct calls to Swift's API checker with the new SPM diagnose-api-breaking-changes tool. This allows us to get rid of the manual module parsing, build invocations and result comparisons.

Result:

We are now using SPMs diagnose-api-breaking-changes to check for breaking changes.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
### Motivation:

SPM has built in functionality to check the API of modules against a target git treeish. We can use this to simplify our `check_no_api_breakages.sh` script. Closes apple/swift-nio#1239

### Modifications:

This PR, exchanges the direct calls to Swift's API checker with the new SPM `diagnose-api-breaking-changes` tool. This allows us to get rid of the manual module parsing, build invocations and result comparisons.

### Result:

We are now using SPMs `diagnose-api-breaking-changes` to check for breaking changes.
@Lukasa Lukasa added the semver/none No version bump required. label Mar 24, 2022
@Lukasa
Copy link
Collaborator

Lukasa commented Mar 24, 2022

@swift-server-bot add to allowlist

Copy link
Member

@fabianfett fabianfett left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Collaborator

@dnadoba dnadoba left a comment

Choose a reason for hiding this comment

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

Awesome!

@FranzBusch
Copy link
Collaborator Author

Nightly and 5.7 failed due to Sendable checks.

@FranzBusch FranzBusch merged commit b1e4f19 into main Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

switch to SwiftPM's swift package experimental-api-diff
4 participants