[build] Use compiler constant to toggle experimental public apis

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ on:
     - '**.md'
 
 jobs:
-  build-test:
+  build-test-stable:
     strategy:
       fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
       matrix:
@@ -31,7 +31,32 @@ jobs:
       run: dotnet restore
 
     - name: Build
-      run: dotnet build --configuration Release --no-restore
+      run: dotnet build --configuration Release --no-restore --property:ExposeExperimentalFeatures=false
+
+    - name: Test ${{ matrix.version }}
+      run: dotnet test **/bin/**/${{ matrix.version }}/*.Tests.dll --logger:"console;verbosity=detailed"
+
+  build-test-experimental:
+    strategy:
+      fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
+      matrix:
+        os: [ windows-latest, ubuntu-latest ]
+        version: [ net462, net6.0, net7.0 ]
+        exclude:
+        - os: ubuntu-latest
+          version: net462
+
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # fetching all
+
+    - name: Install dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build --configuration Release --no-restore --property:ExposeExperimentalFeatures=true
 
     - name: Test ${{ matrix.version }}
       run: dotnet test **/bin/**/${{ matrix.version }}/*.Tests.dll --logger:"console;verbosity=detailed"

Directory.Packages.props

@@ -15,7 +15,7 @@
     <PackageVersion Include="Grpc.Tools" Version="[2.44.0,3.0)" />
     <PackageVersion Include="Microsoft.AspNetCore.Http.Abstractions" Version="[2.1.1,6.0)" />
     <PackageVersion Include="Microsoft.AspNetCore.Http.Features" Version="[2.1.1,6.0)" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="[3.3.3]" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="[3.11.0-beta1.23402.2]" />
     <PackageVersion Include="Microsoft.CodeCoverage" Version="[17.4.1]" />
     <PackageVersion Include="Microsoft.CSharp" Version="[4.7.0]" />
     <PackageVersion Include="Microsoft.Extensions.Configuration" Version="[3.1.0,)" />

NuGet.config

@@ -1,11 +1,9 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <packageSources>
     <clear />
     <add key="NuGet" value="https://api.nuget.org/v3/index.json" />
-    <!--
-    <add key="dotnet6" value="https://dnceng.pkgs.visualstudio.com/public/_packaging/dotnet6/nuget/v3/index.json" />
-    -->
+    <add key="dotnet8" value="https://dnceng.pkgs.visualstudio.com/public/_packaging/dotnet8/nuget/v3/index.json" />
     <add key=".Net Core Tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json" />
   </packageSources>
 
@@ -16,6 +14,9 @@
     <packageSource key="NuGet">
       <package pattern="*" />
     </packageSource>
+    <packageSource key="dotnet8">
+      <package pattern="*.PublicApiAnalyzers" />
+    </packageSource>
     <packageSource key=".Net Core Tools">
       <package pattern="*.ApiCompat" />
     </packageSource>

build/Common.prod.props

@@ -49,14 +49,17 @@
     <NoWarn>$(NoWarn),1573,1712</NoWarn>
     <PackageOutputPath Condition="$(Build_ArtifactStagingDirectory) != ''">$(Build_ArtifactStagingDirectory)</PackageOutputPath>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <!--<MinVerVerbosity>detailed</MinVerVerbosity>-->
     <ApiCompatExcludeAttributeList>$(RepoRoot)\build\GlobalAttrExclusions.txt</ApiCompatExcludeAttributeList>
   </PropertyGroup>
 
   <Target Name="AssemblyVersionTarget" AfterTargets="MinVer" Condition="'$(MinVerVersion)'!='' AND '$(BuildNumber)' != ''">
     <PropertyGroup>
       <FileVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch).$(BuildNumber)</FileVersion>
+      <ExposeExperimentalFeatures Condition="'$(MinVerPreRelease)' != ''">true</ExposeExperimentalFeatures>
+      <ExposeExperimentalFeatures Condition="'$(MinVerPreRelease)' == ''">false</ExposeExperimentalFeatures>
     </PropertyGroup>
+
+    <Message Importance="high" Text="**AssemblyVersionDebug** TargetFramework: $(TargetFramework), MinVerVersion: $(MinVerVersion), MinVerMajor: $(MinVerMajor), MinVerMinor: $(MinVerMinor), MinVerPatch: $(MinVerPatch), MinVerPreRelease: $(MinVerPreRelease), BuildNumber: $(BuildNumber), FileVersion: $(FileVersion), ExposeExperimentalFeatures: $(ExposeExperimentalFeatures)" />
   </Target>
 
   <PropertyGroup>
@@ -92,10 +95,10 @@
 
   <!--PublicApi Analyzer-->
   <ItemGroup>
-    <AdditionalFiles Include=".publicApi\$(TargetFramework)\PublicAPI.Shipped.txt" />
-    <AdditionalFiles Include=".publicApi\$(TargetFramework)\PublicAPI.Unshipped.txt" />
-    <None Include=".publicApi\*\PublicAPI.Shipped.txt" />
-    <None Include=".publicApi\*\PublicAPI.Unshipped.txt" />
+    <AdditionalFiles Include=".publicApi\Stable\$(TargetFramework)\PublicAPI.*.txt" />
+    <AdditionalFiles Include=".publicApi\Experimental\$(TargetFramework)\PublicAPI.*.txt" Condition="'$(ExposeExperimentalFeatures)' == 'true'" />
+    <AdditionalFiles Include=".publicApi\$(TargetFramework)\PublicAPI.*.txt" />
+    <None Include=".publicApi\**\PublicAPI.*.txt" />
   </ItemGroup>
 
 </Project>

build/Common.props

@@ -10,6 +10,11 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <!--temporarily disable. See 3958-->
     <!--<AnalysisLevel>latest-All</AnalysisLevel>-->
+    <ExposeExperimentalFeatures Condition="'$(ExposeExperimentalFeatures)' == ''">true</ExposeExperimentalFeatures>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(ExposeExperimentalFeatures)' == 'true'">
+    <DefineConstants>$(DefineConstants);EXPOSE_EXPERIMENTAL_FEATURES</DefineConstants>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)'=='Debug'">

src/OpenTelemetry.Api/.publicApi/Experimental/net462/PublicAPI.Unshipped.txt

@@ -0,0 +1,80 @@
+abstract OpenTelemetry.Logs.Experimental.Logger.EmitLog(in OpenTelemetry.Logs.Experimental.LogRecordData data, in OpenTelemetry.Logs.Experimental.LogRecordAttributeList attributes) -> void
+abstract OpenTelemetry.Logs.Experimental.LoggerProviderBuilder.AddInstrumentation<TInstrumentation>(System.Func<TInstrumentation!>! instrumentationFactory) -> OpenTelemetry.Logs.Experimental.LoggerProviderBuilder!
+OpenTelemetry.Logs.Experimental.IDeferredLoggerProviderBuilder
+OpenTelemetry.Logs.Experimental.IDeferredLoggerProviderBuilder.Configure(System.Action<System.IServiceProvider!, OpenTelemetry.Logs.Experimental.LoggerProviderBuilder!>! configure) -> OpenTelemetry.Logs.Experimental.LoggerProviderBuilder!
+OpenTelemetry.Logs.Experimental.Logger
+OpenTelemetry.Logs.Experimental.Logger.EmitLog(in OpenTelemetry.Logs.Experimental.LogRecordData data) -> void
+OpenTelemetry.Logs.Experimental.Logger.Logger(string? name) -> void
+OpenTelemetry.Logs.Experimental.Logger.Name.get -> string!
+OpenTelemetry.Logs.Experimental.Logger.Version.get -> string?
+OpenTelemetry.Logs.Experimental.LoggerProvider
+OpenTelemetry.Logs.Experimental.LoggerProvider.GetLogger() -> OpenTelemetry.Logs.Experimental.Logger!
+OpenTelemetry.Logs.Experimental.LoggerProvider.GetLogger(string? name) -> OpenTelemetry.Logs.Experimental.Logger!
+OpenTelemetry.Logs.Experimental.LoggerProvider.GetLogger(string? name, string? version) -> OpenTelemetry.Logs.Experimental.Logger!
+OpenTelemetry.Logs.Experimental.LoggerProvider.LoggerProvider() -> void
+OpenTelemetry.Logs.Experimental.LoggerProviderBuilder
+OpenTelemetry.Logs.Experimental.LoggerProviderBuilder.LoggerProviderBuilder() -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Add(string! key, object? value) -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Add(System.Collections.Generic.KeyValuePair<string!, object?> attribute) -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Clear() -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Count.get -> int
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Enumerator
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Enumerator.Current.get -> System.Collections.Generic.KeyValuePair<string!, object?>
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Enumerator.Dispose() -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Enumerator.Enumerator() -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Enumerator.MoveNext() -> bool
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.GetEnumerator() -> OpenTelemetry.Logs.Experimental.LogRecordAttributeList.Enumerator
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.LogRecordAttributeList() -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.RecordException(System.Exception! exception) -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.this[int index].get -> System.Collections.Generic.KeyValuePair<string!, object?>
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.this[int index].set -> void
+OpenTelemetry.Logs.Experimental.LogRecordAttributeList.this[string! key].set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData
+OpenTelemetry.Logs.Experimental.LogRecordData.Body.get -> string?
+OpenTelemetry.Logs.Experimental.LogRecordData.Body.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.LogRecordData() -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.LogRecordData(in System.Diagnostics.ActivityContext activityContext) -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.LogRecordData(System.Diagnostics.Activity? activity) -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.Severity.get -> OpenTelemetry.Logs.Experimental.LogRecordSeverity?
+OpenTelemetry.Logs.Experimental.LogRecordData.Severity.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.SeverityText.get -> string?
+OpenTelemetry.Logs.Experimental.LogRecordData.SeverityText.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.SpanId.get -> System.Diagnostics.ActivitySpanId
+OpenTelemetry.Logs.Experimental.LogRecordData.SpanId.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.Timestamp.get -> System.DateTime
+OpenTelemetry.Logs.Experimental.LogRecordData.Timestamp.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.TraceFlags.get -> System.Diagnostics.ActivityTraceFlags
+OpenTelemetry.Logs.Experimental.LogRecordData.TraceFlags.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordData.TraceId.get -> System.Diagnostics.ActivityTraceId
+OpenTelemetry.Logs.Experimental.LogRecordData.TraceId.set -> void
+OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Debug = 5 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Debug2 = 6 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Debug3 = 7 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Debug4 = 8 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Error = 17 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Error2 = 18 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Error3 = 19 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Error4 = 20 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Fatal = 21 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Fatal2 = 22 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Fatal3 = 23 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Fatal4 = 24 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Info = 9 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Info2 = 10 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Info3 = 11 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Info4 = 12 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Trace = 1 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Trace2 = 2 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Trace3 = 3 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Trace4 = 4 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Unspecified = 0 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Warn = 13 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Warn2 = 14 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Warn3 = 15 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverity.Warn4 = 16 -> OpenTelemetry.Logs.Experimental.LogRecordSeverity
+OpenTelemetry.Logs.Experimental.LogRecordSeverityExtensions
+static OpenTelemetry.Logs.Experimental.LogRecordAttributeList.CreateFromEnumerable(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string!, object?>>! attributes) -> OpenTelemetry.Logs.Experimental.LogRecordAttributeList
+static OpenTelemetry.Logs.Experimental.LogRecordSeverityExtensions.ToShortName(this OpenTelemetry.Logs.Experimental.LogRecordSeverity logRecordSeverity) -> string!
+virtual OpenTelemetry.Logs.Experimental.LoggerProvider.TryCreateLogger(string? name, out OpenTelemetry.Logs.Experimental.Logger? logger) -> bool