ci: Auto-accept API verifier changes in PRs#5228
Draft
jamescrosswell wants to merge 1 commit into
Draft
Conversation
Adds a new `verify api` workflow that runs the ApiApprovalTests on macOS (covers .NET / netstandard / iOS / MacCatalyst / Android TFMs) and Windows (covers the net48 / .NET Framework TFM), then runs scripts/accept-verifier-changes.ps1 over the resulting *.received.* files and pushes the accepted snapshots back to the PR branch. When API changes are accepted, the PR is also labelled `public API`. For PRs from forks (where we can't push back), the workflow fails with a hint telling the contributor how to accept the changes locally. Closes #5157 Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5228 +/- ##
==========================================
- Coverage 74.13% 74.13% -0.01%
==========================================
Files 508 508
Lines 18282 18282
Branches 3574 3574
==========================================
- Hits 13554 13553 -1
- Misses 3859 3860 +1
Partials 869 869 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
1 participant
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
Adds a new
verify apiworkflow that auto-accepts API approval test snapshot changes on PRs, similar to the existingformat-codeworkflow.ApiApprovalTestson a matrix ofmacos-15(covers .NET / netstandard / iOS / MacCatalyst / Android TFMs) andwindows-latest(covers thenet48/ .NET Framework TFM, which is the common pain point when developing on non-Windows).*.received.*files as artifacts.scripts/accept-verifier-changes.ps1, and pushes the accepted snapshots back to the PR branch.public API(the label is created on demand if it doesn't yet exist).format-code.yml.The Alternative suggested in the issue (switching to
Microsoft.CodeAnalysis.PublicApiAnalyzers) is intentionally out of scope for this PR and can be considered in a follow-up.Closes #5157