Skip to content

Track the public API surface #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomhurst merged 2 commits into from
Jul 21, 2026
Merged

Track the public API surface #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9edc5c7
chore: track public API surface
thomhurst Jul 21, 2026
601201d
fix: sync public API baseline (#356)
thomhurst Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing

## Public API changes

`Microsoft.CodeAnalysis.PublicApiAnalyzers` tracks the library's public surface. A build fails when public members change without a matching baseline update.

For an intentional API change:

1. Add new declarations to `EnumerableAsyncProcessor/PublicAPI.Unshipped.txt`.
2. Prefix removed declarations with `*REMOVED*` in `PublicAPI.Unshipped.txt`.
3. Include the baseline changes in the same pull request as the code change so reviewers can inspect the public API diff.
4. Move approved declarations from `PublicAPI.Unshipped.txt` to `PublicAPI.Shipped.txt` when preparing a release. Keep `#nullable enable` as the first line in both files.

Run `dotnet build` to verify the baseline on every target framework.
9 changes: 9 additions & 0 deletions EnumerableAsyncProcessor/EnumerableAsyncProcessor.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
<Version>99.99.99</Version>
<WarningsAsErrors>$(WarningsAsErrors);RS0016;RS0017</WarningsAsErrors>
<!-- Existing overload families intentionally retain optional parameters. -->
<NoWarn>$(NoWarn);RS0026</NoWarn>
</PropertyGroup>

<PropertyGroup>
Expand All @@ -30,9 +33,15 @@

<PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.301" PrivateAssets="All"/>
<PackageReference Include="System.Threading.RateLimiting" Version="10.0.10" />
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="5.6.0" PrivateAssets="All" />

</ItemGroup>

<ItemGroup>
<AdditionalFiles Include="PublicAPI.Shipped.txt" />
<AdditionalFiles Include="PublicAPI.Unshipped.txt" />
</ItemGroup>

<PropertyGroup>
<Authors>Tom Longhurst</Authors>
<Description>Various Enumerable Async Processors - Batch / Parallel / Rate Limited / One at a time</Description>
Expand Down
Loading
Loading