Prevent PublicAPI File Additions using a workflow #5155
Closed
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
Contributor
Author
|
result from the run
|
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.
Fixes #
Changes proposed in this request
This PR introduces a GitHub Actions workflow that automatically detects and blocks accidental additions of PublicAPI.Shipped.txt and PublicAPI.Unshipped.txt in .csproj files. This ensures that these files are not mistakenly committed, preventing unintended changes to the csproj structure.
Given that this is a commonly edited file this workflow should catch it.
This pull request introduces a new GitHub Actions workflow to prevent the addition of
PublicAPIfiles in.csprojproject files. The most important change is the creation of theprevent-publicapi-addition.ymlworkflow file.New GitHub Actions workflow:
.github/workflows/prevent-publicapi-addition.yml: Added a workflow named "Prevent PublicAPI File Additions" that runs on pull requests. It checks out the code and scans for accidental references toPublicAPI.Shipped.txtorPublicAPI.Unshipped.txtin.csprojfiles, and fails the check if any are found.Testing
build
Performance impact
none
Documentation