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

Warn when a pull request changes the public API #683

Closed
1ec5 opened this issue Apr 21, 2022 · 2 comments
Closed

Warn when a pull request changes the public API #683

1ec5 opened this issue Apr 21, 2022 · 2 comments
Labels
build op-ex Refactoring, Tech Debt or any other operational excellence work.

Comments

@1ec5
Copy link
Contributor

1ec5 commented Apr 21, 2022

A CI bot should automatically diff the public API in each pull request with a baseline commit. If the pull request changes the public API in a backwards incompatible manner, the bot should automatically post a comment warning about the breakage. mapbox/mapbox-navigation-ios#3103 implemented this workflow for the navigation SDK, but this library is subject to a similar backwards compatibility guarantee and should benefit from the same guardrail.

/cc @mapbox/navigation-ios

@1ec5 1ec5 added build op-ex Refactoring, Tech Debt or any other operational excellence work. labels Apr 21, 2022
@bamx23
Copy link
Contributor

bamx23 commented Apr 21, 2022

@1ec5 I believe it was added just recently by @S2Ler: #677

@1ec5
Copy link
Contributor Author

1ec5 commented Apr 21, 2022

Ah, that explains why it didn’t show up in #684. 👍

@1ec5 1ec5 closed this as not planned Won't fix, can't repro, duplicate, stale Apr 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build op-ex Refactoring, Tech Debt or any other operational excellence work.
Projects
None yet
Development

No branches or pull requests

2 participants