Skip to content

chore: enable public API compat validation #680

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
jmaeagle99 merged 7 commits into from
May 15, 2026
Merged

chore: enable public API compat validation #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
88c8ad7
Enable public API change validation
jmaeagle99 May 8, 2026
74ffe03
Merge branch 'main' into apibaseline
jmaeagle99 May 15, 2026
08a6850
Merge branch 'main' into apibaseline
jmaeagle99 May 15, 2026
5871567
Merge branch 'main' into apibaseline
jmaeagle99 May 15, 2026
0615b84
Merge branch 'main' into apibaseline
jmaeagle99 May 15, 2026
9d13fc4
Update suppressions
jmaeagle99 May 15, 2026
66eaf3b
Fail baseline check if suppression is unnecessary
jmaeagle99 May 15, 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
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@ jobs:
run: |
dotnet test --logger "console;verbosity=detailed" --logger "trx;LogFilePrefix=test-results" --results-directory tests/Temporalio.Tests/TestResults --blame-crash -v n --blame-hang-timeout 10m

- name: Validate package API surface
# Package API validation runs only during the Pack target and is
# platform-independent so running on one OS is sufficient.
if: ${{ matrix.os == 'ubuntu-latest' }}
run: dotnet pack -c Debug --no-restore

- name: Upload test results
if: ${{ !cancelled() }}
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
Expand Down
9 changes: 9 additions & 0 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@
leave revision off.
-->
<AssemblyVersion>1.14.1</AssemblyVersion>

<!--
Validate the public API surface of every packable project against the
previously published version. Auto-skips for IsPackable=false projects.
Bump PackageValidationBaselineVersion when releasing.
-->
<EnablePackageValidation>true</EnablePackageValidation>
<PackageValidationBaselineVersion>1.14.1</PackageValidationBaselineVersion>
<ApiCompatPermitUnnecessarySuppressions>false</ApiCompatPermitUnnecessarySuppressions>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions src/Temporalio.Api.Generator/Temporal.Api.Generator.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<PropertyGroup>
<ImplicitUsings>enable</ImplicitUsings>
<IsPackable>false</IsPackable>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0</TargetFramework>
</PropertyGroup>
Expand Down
1 change: 0 additions & 1 deletion src/Temporalio.Extensions.DiagnosticSource/Temporalio.Extensions.DiagnosticSource.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

<PropertyGroup>
<Description>Temporal SDK .NET Diagnostic Source Extension</Description>
<EnablePackageValidation Condition="'$(TargetFramework)' == 'netcoreapp3.1'">true</EnablePackageValidation>
<IncludeSymbols>true</IncludeSymbols>
<LangVersion>9.0</LangVersion>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand Down
1 change: 0 additions & 1 deletion src/Temporalio.Extensions.Hosting/Temporalio.Extensions.Hosting.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

<PropertyGroup>
<Description>Temporal SDK .NET Hosting and Dependency Injection Extension</Description>
<EnablePackageValidation Condition="'$(TargetFramework)' == 'netcoreapp3.1'">true</EnablePackageValidation>
<IncludeSymbols>true</IncludeSymbols>
<LangVersion>9.0</LangVersion>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand Down
1 change: 0 additions & 1 deletion src/Temporalio.Extensions.OpenTelemetry/Temporalio.Extensions.OpenTelemetry.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

<PropertyGroup>
<Description>Temporal SDK .NET OpenTelemetry Extension</Description>
<EnablePackageValidation Condition="'$(TargetFramework)' == 'netcoreapp3.1'">true</EnablePackageValidation>
<IncludeSymbols>true</IncludeSymbols>
<LangVersion>9.0</LangVersion>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand Down
209 changes: 209 additions & 0 deletions src/Temporalio/CompatibilitySuppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids -->
<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Suppression>
<DiagnosticId>CP0001</DiagnosticId>
<Target>T:Temporalio.Worker.Interceptors.StartNexusOperationInput</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0001</DiagnosticId>
<Target>T:Temporalio.Worker.Interceptors.StartNexusOperationInput</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0001</DiagnosticId>
<Target>T:Temporalio.Worker.Interceptors.StartNexusOperationInput</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Temporalio.Worker.Interceptors.WorkflowOutboundInterceptor.StartNexusOperationAsync``1(Temporalio.Worker.Interceptors.StartNexusOperationInput)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Temporalio.Worker.Interceptors.WorkflowOutboundInterceptor.StartNexusOperationAsync``1(Temporalio.Worker.Interceptors.StartNexusOperationInput)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Temporalio.Worker.Interceptors.WorkflowOutboundInterceptor.StartNexusOperationAsync``1(Temporalio.Worker.Interceptors.StartNexusOperationInput)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CountNexusOperationsAsync(System.String,Temporalio.Client.NexusOperationCountOptions)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CreateNexusClient(System.String,System.String)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CreateNexusClient``1(System.String)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.GetNexusOperationHandle(System.String,System.String)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.GetNexusOperationHandle``1(System.String,System.String)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListNexusOperationsPaginatedAsync(System.String,System.Byte[],Temporalio.Client.NexusOperationListPaginatedOptions)</Target>
<Left>lib/net462/Temporalio.dll</Left>
<Right>lib/net462/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CountNexusOperationsAsync(System.String,Temporalio.Client.NexusOperationCountOptions)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CreateNexusClient(System.String,System.String)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CreateNexusClient``1(System.String)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.GetNexusOperationHandle(System.String,System.String)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.GetNexusOperationHandle``1(System.String,System.String)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListNexusOperationsAsync(System.String,Temporalio.Client.NexusOperationListOptions)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListNexusOperationsPaginatedAsync(System.String,System.Byte[],Temporalio.Client.NexusOperationListPaginatedOptions)</Target>
<Left>lib/netcoreapp3.1/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListActivitiesAsync(System.String,Temporalio.Client.ActivityListOptions)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListNexusOperationsAsync(System.String,Temporalio.Client.NexusOperationListOptions)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListSchedulesAsync(Temporalio.Client.Schedules.ScheduleListOptions)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListWorkflowsAsync(System.String,Temporalio.Client.WorkflowListOptions)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Worker.ITemporalWorkerPlugin.ReplayWorkflowsAsync(Temporalio.Worker.WorkflowReplayer,System.Func{Temporalio.Worker.WorkflowReplayer,System.Collections.Generic.IAsyncEnumerable{Temporalio.Worker.WorkflowReplayResult}},System.Threading.CancellationToken)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netcoreapp3.1/Temporalio.dll</Right>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CountNexusOperationsAsync(System.String,Temporalio.Client.NexusOperationCountOptions)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CreateNexusClient(System.String,System.String)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.CreateNexusClient``1(System.String)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.GetNexusOperationHandle(System.String,System.String)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.GetNexusOperationHandle``1(System.String,System.String)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0006</DiagnosticId>
<Target>M:Temporalio.Client.ITemporalClient.ListNexusOperationsPaginatedAsync(System.String,System.Byte[],Temporalio.Client.NexusOperationListPaginatedOptions)</Target>
<Left>lib/netstandard2.0/Temporalio.dll</Left>
<Right>lib/netstandard2.0/Temporalio.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
</Suppressions>
1 change: 0 additions & 1 deletion src/Temporalio/Temporalio.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
<PropertyGroup>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<Description>Temporal SDK for .NET</Description>
<EnablePackageValidation Condition="'$(TargetFramework)' == 'netcoreapp3.1'">true</EnablePackageValidation>
<IncludeSymbols>true</IncludeSymbols>
<LangVersion>9.0</LangVersion>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand Down
7 changes: 7 additions & 0 deletions tests/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<Project>
<Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />

<PropertyGroup>
<IsPackable>false</IsPackable>
</PropertyGroup>
</Project>
Loading