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

[SR-10540] SwiftPM: integration with swift-api-digester would be really cool #4716

Closed
weissi opened this issue Apr 23, 2019 · 5 comments
Closed
Labels

Comments

@weissi
Copy link
Member

weissi commented Apr 23, 2019

Previous ID SR-10540
Radar rdar://problem/52798997
Original Reporter @weissi
Type Bug
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 8
Component/s Package Manager
Labels Bug
Assignee owenvoorhees (JIRA)
Priority Medium

md5: 042f05d014f2f1462381949a6f295c9c

Issue Description:

It would be really cool, if SwiftPM could provide some assistance with the help of swift-api-digester. For example:

  • when tagging a patch version, run swift-api-digester and make sure that no API was added/removed/changed

  • when tagging a minor version, run swift-api-digester and make sure that no API was broken

I think it would enough if we had this behind a flag. Maybe something like

swift package tag-version --verify-api-changes 1.2.3

or so. Another amazing feature would be

swift package show-api-changes --since 1.2.1

which could show all API changes that the current branch has since 1.2.1.

We're just about to implement an API breakage checker for SwiftNIO's CI. It's still very WIP but here's what we have today: https://github.com/apple/swift-nio/compare/master...tomerd:feature/tools?expand=1#diff-97c1781a7256db3181f6734adbf5e7f6

@weissi
Copy link
Member Author

weissi commented Jul 2, 2019

@swift-ci create

@ankitspd
Copy link
Member

Here's some basic integration: #2406

@swift-ci
Copy link
Contributor

Comment by Rich Ellis (JIRA)

There's a Github Action based on the SwiftNIO script: https://github.com/marketplace/actions/swift-api-diff

It would be fantastic to have this built into SwiftPM!

@swift-ci
Copy link
Contributor

Comment by Owen Voorhees (JIRA)

`swift package experimental-api-diff` has now been extended and renamed to `swift package diagnose-api-breaking-changes`, tested on macOS & Linux CI, and should be available in the next nightly snapshot. I'm going to track future enhancements in individual issues now that the basic functionality is in place and tested. The old name is still accepted by SwiftPM and will print a removal notice

apple/swift#36381

#3359

apple/swift#37206

apple/swift#37236

apple/swift-tools-support-core#213

#3485

apple/swift#37703

#3519

#3532

#3547

apple/swift#37991

#3593

#3633

@weissi
Copy link
Member Author

weissi commented Jul 27, 2021

That's super awesome, thank you!

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 4, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants