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.

Sign up for GitHub

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

Jump to bottom

Run .NET package validation to detect backward compat issues. #2566

Closed
ewoutkramer opened this issue Aug 7, 2023 · 3 comments · Fixed by #2767
Closed

Run .NET package validation to detect backward compat issues. #2566

ewoutkramer opened this issue Aug 7, 2023 · 3 comments · Fixed by #2767
Assignees
@Kasdejong
Labels
enhancement

Comments

@ewoutkramer
Copy link
Member

Although we don't do binary compatibility between our releases, it might still be useful to implement

https://learn.microsoft.com/en-us/dotnet/fundamentals/package-validation/overview

and double check we didn't introduce any incompatible change we did not intent to do, esp. changes to the public interface that break "compilation compatibility".
@ewoutkramer
Copy link
Member Author

Thanks to @almostchristian for pointing this out.

@ewoutkramer ewoutkramer mentioned this issue Aug 7, 2023
Closed
@mmsmits
Copy link
Member

mmsmits commented Apr 4, 2024

First try this in the package library/validator-api to try out.

@Kasdejong Kasdejong self-assigned this Apr 10, 2024
@Kasdejong
Copy link
Contributor

We tried this in the SDK, and the results were good. I will make a pull request with the validation active. From the next release onwards, we are considering using an extra tag "binary breaking change" and try to minimize the number of binary breaking changes we introduce (i.e. back to overloads instead of optional parameters to extend current functionality). The validator can help us with this.

@Kasdejong Kasdejong mentioned this issue Apr 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kasdejong Kasdejong

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

added package validation to the SDK library FirelyTeam/firely-net-sdk
3 participants
@ewoutkramer @mmsmits @Kasdejong