Repository navigation
test: verify the public API with aweXpect.Snapshots.PublicApi - #1868
Merged
Merged
Conversation
The public API was enforced by Microsoft.CodeAnalysis.PublicApiAnalyzers, which needs hand-maintained `PublicAPI.Shipped.txt`/`PublicAPI.Unshipped.txt` files per target framework, a pragma in generated code and a downgrade of RS0016/RS0017 for local Debug builds. `aweXpect.Api.Tests` now compares the public API of every target framework of `aweXpect` and `aweXpect.Core` with snapshots written by `aweXpect.Snapshots.PublicApi`, so a change shows up as readable C# declarations in the pull request and is accepted like any other snapshot (`AcceptApiChanges` or `AWEXPECT_ACCEPT_SNAPSHOTS=all`). The analyzer and its files are removed. As the check is no longer part of the compilation, the `ApiChecks` target and the `API tests` job are back in the CI and build workflows, the release jobs wait for it and Mergify requires it for Dependabot merges. Under `CoreOnly` the check runs on the Debug build, the only one of `aweXpect` that references the changed `aweXpect.Core`.
vbreuss
enabled auto-merge (squash)
October 18, 2026 08:06
|
Contributor
Test Results 92 files +1 92 suites +1 2h 45m 49s ⏱️ + 21m 9s Results for commit 1a265ab. ± Comparison against base commit 352482a. This pull request removes 5074 and adds 4937 tests. Note that renamed tests count towards both. |
Contributor
🚀 Benchmark ResultsDetails
|
github-actions Bot
added a commit
that referenced
this pull request
Oct 18, 2026
…ct.Snapshots.PublicApi (#1868) by Valentin Breuß
github-actions Bot
added a commit
that referenced
this pull request
Oct 18, 2026
…ct.Snapshots.PublicApi (#1868) by Valentin Breuß
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.



The public API was enforced by Microsoft.CodeAnalysis.PublicApiAnalyzers, which needs hand-maintained
PublicAPI.Shipped.txt/PublicAPI.Unshipped.txtfiles per target framework, a pragma in generated code and a downgrade of RS0016/RS0017 for local Debug builds.aweXpect.Api.Testsnow compares the public API of every target framework ofaweXpectandaweXpect.Corewith snapshots written byaweXpect.Snapshots.PublicApi, so a change shows up as readable C# declarations in the pull request and is accepted like any other snapshot (AcceptApiChangesorAWEXPECT_ACCEPT_SNAPSHOTS=all). The analyzer and its files are removed.As the check is no longer part of the compilation, the
ApiCheckstarget and theAPI testsjob are back in the CI and build workflows, the release jobs wait for it and Mergify requires it for Dependabot merges. UnderCoreOnlythe check runs on the Debug build, the only one ofaweXpectthat references the changedaweXpect.Core.