Implement backward compatibility checks #52
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
gasperzgonec
requested review from
radovanjorgic,
patricijabrecko and
a team
as code owners
gasperzgonec
changed the title
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.
Summary
A pretty comprehensive backward-compatibility check, which compares the exported interfaces between current commit and the latest tag and checks if any function signatures or any public types have had any backward-incompatible changes.
Checks for previous versions are included in
version-apifolder in the root.Connected Issues
Story of the craft
This test uses Microsoft's
api-extractor, which generates a report of the current publicly exposed symbols and generates both a JSON file and a Markdown file containing this information.This check uses the
api.jsonfiles that are generated to loop over all publicly exposed symbols and compares their signatures, verifying that backward-compatibility promise is being maintained.