-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Api diff #4348
Merged
Merged
Api diff #4348
Conversation
This file contains 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
Co-authored-by: Jeremy Koritzinsky <jkoritzinsky@gmail.com>
Gillibald
reviewed
Jul 23, 2020
In future we can exclude certain types, methods and classes from api checks with attributes and have a single baseline file for the entire solution... however this is currently blocked by: |
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.
What does the pull request do?
This ensures binary compatibility with a specified version (currently
0.10.0-preview1
)Binary api changes will cause an error.
used this guide: https://stu.dev/check-for-breaking-changes-with-apicompat/
There are
ApiCompatBaseLine.txt
files next to csproj with breaking changes since the specified release.i.e.
Those files allow breaking changes to be allowed.
These files can be generated when a breaking change occurs using...
dotnet build /p:BaselineAllAPICompatError=true
They can then be checked in.
My suggestion is these are all removed after 0.10.0 release and 0.10.0 becomes our api promise more or less.
We will also need to do an api review...
We can generate a report comparing to 0.9.11 at the time to help us work out if some stuff was made public that shouldnt and if some apis need fixing.
What is the current behavior?
What is the updated/expected behavior with this PR?
If you make an api change you will get a build error i.e.:
example can be seen here:
https://dev.azure.com/AvaloniaUI/AvaloniaUI/_build/results?buildId=9466&view=results
How was the solution implemented (if it's not obvious)?
Checklist
Breaking changes
Fixed issues