dotnet-api-surface-validation

Installation
SKILL.md

dotnet-api-surface-validation

Tools and workflows for validating and tracking the public API surface of .NET libraries. Covers three complementary approaches: PublicApiAnalyzers for text-file tracking of shipped/unshipped APIs with Roslyn diagnostics, the Verify snapshot pattern for reflection-based API surface snapshot testing, and ApiCompat CI enforcement for gating pull requests on API surface changes.

Version assumptions: .NET 8.0+ baseline. PublicApiAnalyzers 3.3+ (ships with Microsoft.CodeAnalysis.Analyzers or standalone Microsoft.CodeAnalysis.PublicApiAnalyzers). ApiCompat tooling included in .NET 8+ SDK.

Scope

  • PublicApiAnalyzers text-file tracking of shipped/unshipped APIs
  • Verify snapshot pattern for reflection-based API surface testing
  • ApiCompat CI enforcement for gating PRs on breaking changes
  • Multi-TFM and monorepo API tracking strategies
  • PR labeling and suppression file workflows

Out of scope

  • Binary vs source compatibility rules, type forwarders, SemVer impact -- see [skill:dotnet-library-api-compat]
  • NuGet packaging, EnablePackageValidation basics, and suppression file mechanics -- see [skill:dotnet-nuget-authoring] and [skill:dotnet-multi-targeting]
  • Verify library fundamentals (setup, scrubbing, converters) -- see [skill:dotnet-snapshot-testing]
Related skills

More from novotnyllc/dotnet-artisan

Installs
4
GitHub Stars
208
First Seen
Feb 24, 2026