Add PublicApi analyzer to SortingNetworks class library#109
Merged
Conversation
Add Microsoft.CodeAnalysis.PublicApiAnalyzers 3.3.4 with all existing APIs listed in PublicAPI.Unshipped.txt. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds build-time public API tracking to the SortingNetworks package so accidental breaking changes to its intentionally small public surface are caught during development. In the context of this repo, that safeguards the class-library side of the package while the bundled source generator remains implementation detail.
Changes:
- Added
Microsoft.CodeAnalysis.PublicApiAnalyzersas a private build dependency for theSortingNetworksproject. - Added
PublicAPI.Unshipped.txtenumerating the current public API surface ofSortingNetworkAttribute. - Added an initial empty
PublicAPI.Shipped.txtbaseline for future releases.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
SortingNetworks/SortingNetworks.csproj |
Adds the Public API analyzer package to enforce API surface tracking at build time. |
SortingNetworks/PublicAPI.Unshipped.txt |
Records the current unshipped public APIs for SortingNetworkAttribute. |
SortingNetworks/PublicAPI.Shipped.txt |
Initializes the shipped API baseline file required by the analyzer. |
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
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.
Track the public API surface of the SortingNetworks class library so that accidental breaking changes are caught at build time, matching the setup used in jonathanpeppers/dotnes.
What changed:
Microsoft.CodeAnalysis.PublicApiAnalyzers3.3.4 as aPrivateAssets="all"dependencyPublicAPI.Shipped.txt(empty -- nothing shipped yet)PublicAPI.Unshipped.txtwith all current public APIs (SortingNetworkAttribute, its constructor, and its two properties)The build passes clean with 0 warnings and 0 errors.