[APIDiff] Support forwarding breakage allowlists to the api digester #3547
Conversation
This file contains hidden or 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
owenv
requested review from
abertelrud,
friedbunny,
neonichu and
tomerd
as code owners
|
@swift-ci smoke test |
tomerd
approved these changes
Jun 14, 2021
elsh
requested changes
Jun 17, 2021
| The path to a text file containing breaking changes which should be ignored by the API comparison. \ | ||
| Each ignored breaking change in the file should appear on its own line and contain the exact message \ | ||
| to be ignored (e.g. 'API breakage: func foo() has been removed'). If this option is not present, \ | ||
| a file named 'api-breakage-allowlist.txt' at the package root will be used if it exists. |
There was a problem hiding this comment.
The default behavior doesn't seem intuitive for this input option and it would be cleaner to just require a specific path to be passed in by a user.
owenv
force-pushed
the
breakage-allowlist
branch
from
b27e14a to
e6b7061
Compare
|
@swift-ci smoke test |
elsh
reviewed
Jun 18, 2021
elsh
reviewed
Jun 18, 2021
elsh
approved these changes
Jun 18, 2021
Co-authored-by: elsh <[email protected]>
|
@swift-ci smoke test |
|
@swift-ci please smoke test macOS |
|
yeah, I think this should be ok to merge now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a --breakage-allowlist-path flag to allow ignoring specified breaking changes when running experimental-api-diff
Motivation:
Sometimes, it's beneficial to be able to ignore certain API breaking changes when perfect API compatibility isn't necessary.
Modifications:
Result:
Users can choose to ignore certain API-breaking changes when running comparisons