Refine SqlClient pack fallback and nuspec version flow

- Move Abstractions/Logging version fallback into SqlClient pack target

- Reuse shared sibling project paths and DOTNET_HOST_PATH

- Document intermediate nuspec generation and sibling version evaluation

- Pass NuspecVersion through shared nuget pack pipeline properties

Author: paulmedynski

build.proj

@@ -535,60 +535,7 @@
       <Output TaskParameter="ConsoleOutput" PropertyName="CommitId" />
     </Exec>
 
-    <Error Text="PackSqlClient requires PackageVersionAbstractions. Specify -p:PackageVersionAbstractions=&lt;version&gt;."
-           Condition="'$(PackageVersionAbstractions)' == ''" />
-    <Error Text="PackSqlClient requires PackageVersionLogging. Specify -p:PackageVersionLogging=&lt;version&gt;."
-           Condition="'$(PackageVersionLogging)' == ''" />
-
-    <!-- Evaluate AbstractionsPackageVersion from project if not provided -->
-    <PropertyGroup Condition="'$(PackageVersionAbstractions)' == ''">
-      <GetAbstractionsPackageVersionCommand>
-        "$(DotnetPath)dotnet" msbuild "$(AbstractionsProjectPath)"
-        -nologo
-        -verbosity:quiet
-        -getProperty:AbstractionsPackageVersion
-        $(BuildNumberArgument)
-        $(BuildSuffixArgument)
-      </GetAbstractionsPackageVersionCommand>
-      <GetAbstractionsPackageVersionCommand>$([System.Text.RegularExpressions.Regex]::Replace($(GetAbstractionsPackageVersionCommand), "\s+", " "))</GetAbstractionsPackageVersionCommand>
-    </PropertyGroup>
-    <Message Text=">>> Evaluating Abstractions package version via command: $(GetAbstractionsPackageVersionCommand)"
-             Condition="'$(PackageVersionAbstractions)' == ''" />
-    <Exec ConsoleToMsBuild="true" Command="$(GetAbstractionsPackageVersionCommand)"
-          Condition="'$(PackageVersionAbstractions)' == ''">
-      <Output TaskParameter="ConsoleOutput" PropertyName="PackageVersionAbstractions" />
-    </Exec>
-    <Error Text="Failed to evaluate AbstractionsPackageVersion for PackSqlClient."
-           Condition="'$(PackageVersionAbstractions)' == ''" />
-
-    <!-- Evaluate LoggingPackageVersion from project if not provided -->
-    <PropertyGroup Condition="'$(PackageVersionLogging)' == ''">
-      <GetLoggingPackageVersionCommand>
-        "$(DotnetPath)dotnet" msbuild "$(LoggingProjectPath)"
-        -nologo
-        -verbosity:quiet
-        -getProperty:LoggingPackageVersion
-        $(BuildNumberArgument)
-        $(BuildSuffixArgument)
-      </GetLoggingPackageVersionCommand>
-      <GetLoggingPackageVersionCommand>$([System.Text.RegularExpressions.Regex]::Replace($(GetLoggingPackageVersionCommand), "\s+", " "))</GetLoggingPackageVersionCommand>
-    </PropertyGroup>
-    <Message Text=">>> Evaluating Logging package version via command: $(GetLoggingPackageVersionCommand)"
-             Condition="'$(PackageVersionLogging)' == ''" />
-    <Exec ConsoleToMsBuild="true" Command="$(GetLoggingPackageVersionCommand)"
-          Condition="'$(PackageVersionLogging)' == ''">
-      <Output TaskParameter="ConsoleOutput" PropertyName="PackageVersionLogging" />
-    </Exec>
-    <Error Text="Failed to evaluate LoggingPackageVersion for PackSqlClient."
-           Condition="'$(PackageVersionLogging)' == ''" />
-
     <PropertyGroup>
-<<<<<<< HEAD
-      <_EvaluatedSqlClientPackageVersion>$([System.Text.RegularExpressions.Regex]::Replace($(_EvaluatedSqlClientPackageVersion), "\s", ""))</_EvaluatedSqlClientPackageVersion>
-      <PackageVersionAbstractions>$([System.Text.RegularExpressions.Regex]::Replace($(PackageVersionAbstractions), "\s", ""))</PackageVersionAbstractions>
-      <PackageVersionLogging>$([System.Text.RegularExpressions.Regex]::Replace($(PackageVersionLogging), "\s", ""))</PackageVersionLogging>
-=======
->>>>>>> a31e7e8fc (Simplify SqlClient pack version flow)
       <CommitId>$([System.Text.RegularExpressions.Regex]::Replace($(CommitId), "\s", ""))</CommitId>
       <DotnetCommand>
         "$(DotnetPath)dotnet" pack "$(SqlClientProjectPath)"

eng/pipelines/common/templates/steps/generate-nuget-package-step.yml

@@ -70,11 +70,11 @@ steps:
         ${{parameters.nuspecPath}}
         -Version ${{parameters.packageVersion}}
         -OutputDirectory ${{parameters.outputDirectory}}
-        -properties "COMMITID=$(CommitHead);Configuration=${{parameters.buildConfiguration}};ReferenceType=${{parameters.referenceType}};${{parameters.properties}}"
+        -properties "COMMITID=$(CommitHead);Configuration=${{parameters.buildConfiguration}};ReferenceType=${{parameters.referenceType}};NuspecVersion=${{parameters.packageVersion}};${{parameters.properties}}"
     ${{else }}:
       arguments: >-
         pack
         ${{parameters.nuspecPath}}
         -Version ${{parameters.packageVersion}}
         -OutputDirectory ${{parameters.outputDirectory}}
-        -properties "COMMITID=$(CommitHead);Configuration=${{parameters.buildConfiguration}};ReferenceType=${{parameters.referenceType}};${{parameters.properties}}"
+        -properties "COMMITID=$(CommitHead);Configuration=${{parameters.buildConfiguration}};ReferenceType=${{parameters.referenceType}};NuspecVersion=${{parameters.packageVersion}};${{parameters.properties}}"

src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj

@@ -79,41 +79,90 @@
   <!-- NuGet Package Config ============================================ -->
   <!-- Pack design notes: ./sqlclient-dotnet-pack.md -->
   <PropertyGroup>
+
+    <!-- Spec and proj paths. -->
     <SqlClientPackNuspecTemplatePath Condition="'$(SqlClientPackNuspecTemplatePath)' == ''">$(RepoRoot)tools/specs/Microsoft.Data.SqlClient.nuspec</SqlClientPackNuspecTemplatePath>
     <SqlClientPackNuspecGeneratedPath Condition="'$(SqlClientPackNuspecGeneratedPath)' == ''">$(BaseIntermediateOutputPath)Microsoft.Data.SqlClient.pack.nuspec</SqlClientPackNuspecGeneratedPath>
+    <AbstractionsProjectPath>$(RepoRoot)/src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj</AbstractionsProjectPath>
+    <LoggingProjectPath>$(RepoRoot)/src/Microsoft.Data.SqlClient.Internal/Logging/src/Logging.csproj</LoggingProjectPath>
 
-    <NuspecVersion Condition="'$(NuspecVersion)' == ''">$(Version)</NuspecVersion>
+    <!-- Properties used by dotnet pack. -->
     <NuspecFile Condition="'$(NuspecFile)' == ''">$(SqlClientPackNuspecTemplatePath)</NuspecFile>
     <NuspecBasePath Condition="'$(NuspecBasePath)' == ''">$([System.IO.Path]::GetDirectoryName('$(SqlClientPackNuspecTemplatePath)'))</NuspecBasePath>
+    <NuspecVersion Condition="'$(NuspecVersion)' == ''">$(Version)</NuspecVersion>
+    <NuspecProperties Condition="'$(NuspecProperties)' == ''">COMMITID=$(CommitId);Configuration=$(Configuration);ReferenceType=$(ReferenceType)</NuspecProperties>
     <IncludeSymbols Condition="'$(IncludeSymbols)' == ''">true</IncludeSymbols>
     <SymbolPackageFormat Condition="'$(SymbolPackageFormat)' == ''">snupkg</SymbolPackageFormat>
     <SuppressDependenciesWhenPacking Condition="'$(SuppressDependenciesWhenPacking)' == ''">true</SuppressDependenciesWhenPacking>
-
-    <NuspecProperties Condition="'$(NuspecProperties)' == ''">COMMITID=$(CommitId);Configuration=$(Configuration);ReferenceType=$(ReferenceType)</NuspecProperties>
   </PropertyGroup>
 
   <!--
     SDK pack does not reliably substitute dependency version tokens in this nuspec flow.
     We materialize those dependency versions into an intermediate nuspec before PackTask runs.
+
+    Why an intermediate nuspec is generated:
+    * The source nuspec keeps dependency versions as tokens to stay template-driven.
+    * During SDK-style packing, dependency token substitution is not consistently applied in this flow.
+    * Expanding tokens up front guarantees deterministic dependency versions in the final package metadata.
+
+    Why sibling package versions are evaluated here:
+    * Pack entrypoints may call this project directly and omit Abstractions/Logging version overrides.
+    * Those versions must still align with sibling projects' versioning rules (BuildNumber/BuildSuffix and defaults).
+    * Querying each sibling project for its computed package version preserves a single source of version truth.
   -->
   <Target Name="PrepareSqlClientPackNuspec"
           BeforeTargets="GenerateNuspec"
           Condition="'$(NuspecFile)' == '$(SqlClientPackNuspecTemplatePath)'">
-      <Error Text="PrepareSqlClientPackNuspec requires AbstractionsPackageVersion. Specify -p:AbstractionsPackageVersion=&lt;version&gt; (or -p:PackageVersionAbstractions=&lt;version&gt; when invoking build.proj)."
-        Condition="'$(AbstractionsPackageVersion)' == ''" />
-      <Error Text="PrepareSqlClientPackNuspec requires LoggingPackageVersion. Specify -p:LoggingPackageVersion=&lt;version&gt; (or -p:PackageVersionLogging=&lt;version&gt; when invoking build.proj)."
-        Condition="'$(LoggingPackageVersion)' == ''" />
-      <Error Text="PrepareSqlClientPackNuspec requires NuspecVersion. Specify -p:NuspecVersion=&lt;version&gt;."
-        Condition="'$(NuspecVersion)' == ''" />
 
+    <!-- Calculate AbstractionsPackageVersion if not already set. -->
+    <PropertyGroup Condition="'$(AbstractionsPackageVersion)' == ''">
+      <GetAbstractionsPackageVersionCommand>
+        "$(DOTNET_HOST_PATH)" msbuild "$(AbstractionsProjectPath)"
+        -nologo
+        -verbosity:quiet
+        -getProperty:AbstractionsPackageVersion
+        -p:BuildNumber=$(BuildNumber)
+        -p:BuildSuffix=$(BuildSuffix)
+      </GetAbstractionsPackageVersionCommand>
+      <GetAbstractionsPackageVersionCommand>$([System.Text.RegularExpressions.Regex]::Replace($(GetAbstractionsPackageVersionCommand), "\s+", " "))</GetAbstractionsPackageVersionCommand>
+    </PropertyGroup>
+    <Exec ConsoleToMsBuild="true" Command="$(GetAbstractionsPackageVersionCommand)"
+      Condition="'$(AbstractionsPackageVersion)' == ''">
+      <Output TaskParameter="ConsoleOutput" PropertyName="AbstractionsPackageVersion" />
+    </Exec>
+    <PropertyGroup Condition="'$(GetAbstractionsPackageVersionCommand)' != ''">
+      <AbstractionsPackageVersion>$([System.Text.RegularExpressions.Regex]::Replace($(AbstractionsPackageVersion), "\s", ""))</AbstractionsPackageVersion>
+    </PropertyGroup>
+
+    <!-- Calculate LoggingPackageVersion if not already set. -->
+    <PropertyGroup Condition="'$(LoggingPackageVersion)' == ''">
+      <GetLoggingPackageVersionCommand>
+        "$(DOTNET_HOST_PATH)" msbuild "$(LoggingProjectPath)"
+        -nologo
+        -verbosity:quiet
+        -getProperty:LoggingPackageVersion
+        -p:BuildNumber=$(BuildNumber)
+        -p:BuildSuffix=$(BuildSuffix)
+      </GetLoggingPackageVersionCommand>
+      <GetLoggingPackageVersionCommand>$([System.Text.RegularExpressions.Regex]::Replace($(GetLoggingPackageVersionCommand), "\s+", " "))</GetLoggingPackageVersionCommand>
+    </PropertyGroup>
+    <Exec ConsoleToMsBuild="true" Command="$(GetLoggingPackageVersionCommand)"
+      Condition="'$(LoggingPackageVersion)' == ''">
+      <Output TaskParameter="ConsoleOutput" PropertyName="LoggingPackageVersion" />
+    </Exec>
+    <PropertyGroup Condition="'$(GetLoggingPackageVersionCommand)' != ''">
+      <LoggingPackageVersion>$([System.Text.RegularExpressions.Regex]::Replace($(LoggingPackageVersion), "\s", ""))</LoggingPackageVersion>
+    </PropertyGroup>
+
+    <!-- Expand the SqlClientPackNuspec template with the computed package versions. -->
     <PropertyGroup>
       <_SqlClientPackNuspecExpandedText>$([System.IO.File]::ReadAllText('$(SqlClientPackNuspecTemplatePath)').Replace('$AbstractionsPackageVersion$','$(AbstractionsPackageVersion)').Replace('$LoggingPackageVersion$','$(LoggingPackageVersion)').Replace('$NuspecVersion$','$(NuspecVersion)'))</_SqlClientPackNuspecExpandedText>
     </PropertyGroup>
-
     <WriteLinesToFile File="$(SqlClientPackNuspecGeneratedPath)"
                       Lines="$(_SqlClientPackNuspecExpandedText)"
                       Overwrite="true" />
 
+    <!-- Set the NuspecFile property to the generated nuspec file. -->
     <PropertyGroup>
       <NuspecFile>$(SqlClientPackNuspecGeneratedPath)</NuspecFile>
     </PropertyGroup>
@@ -158,15 +207,15 @@
   <!-- References ====================================================== -->
   <!-- Reference to Abstractions -->
   <ItemGroup>
-    <ProjectReference Include="$(RepoRoot)/src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj"
+    <ProjectReference Include="$(AbstractionsProjectPath)"
                       Condition="'$(ReferenceType)' != 'Package'" />
     <PackageReference Include="Microsoft.Data.SqlClient.Extensions.Abstractions"
                       Condition="'$(ReferenceType)' == 'Package'" />
   </ItemGroup>
 
   <!-- Reference to Logging -->
   <ItemGroup>
-    <ProjectReference Include="$(RepoRoot)/src/Microsoft.Data.SqlClient.Internal/Logging/src/Logging.csproj"
+    <ProjectReference Include="$(LoggingProjectPath)"
                       Condition="'$(ReferenceType)' != 'Package'" />
     <PackageReference Include="Microsoft.Data.SqlClient.Internal.Logging"
                       Condition="'$(ReferenceType)' == 'Package'" />

src/Microsoft.Data.SqlClient/src/sqlclient-dotnet-pack.md

@@ -13,21 +13,27 @@ This document describes how the SqlClient package is produced with dotnet pack i
 Run from repo root:
 
 ```bash
-dotnet build build.proj -t:PackSqlClient -p:Configuration=Release -p:ReferenceType=Project -p:PackBuild=false -p:PackageVersionAbstractions=<version> -p:PackageVersionLogging=<version>
+dotnet build -t:PackSqlClient -p:Configuration=Release -p:ReferenceType=Project -p:PackBuild=false
 ```
 
-Required pack inputs:
+Optional version override inputs:
 
 - `PackageVersionAbstractions`
 - `PackageVersionLogging`
 
-These are required because dependency versions are injected into the SqlClient nuspec at pack time.
+These can still be passed to override sibling package versions, but they are no longer required. If
+omitted, `PrepareSqlClientPackNuspec` evaluates the computed `AbstractionsPackageVersion` and
+`LoggingPackageVersion` from the sibling projects using the current `BuildNumber` and `BuildSuffix`
+context.
 
 ## Why a generated nuspec is used
 
-SqlClient packaging still relies on `tools/specs/Microsoft.Data.SqlClient.nuspec` for file mapping and dependency groups (`lib/*`, `ref/*`, `runtimes/*`, resources, metadata).
+SqlClient packaging still relies on `tools/specs/Microsoft.Data.SqlClient.nuspec` for file mapping
+and dependency groups (`lib/*`, `ref/*`, `runtimes/*`, resources, metadata).
 
-In this flow, SDK pack token substitution is reliable for general nuspec properties, but dependency version token replacement in the nuspec dependency section can fail. To avoid that, the project generates an intermediate nuspec before `GenerateNuspec`:
+In this flow, SDK pack token substitution is reliable for general nuspec properties, but dependency
+version token replacement in the nuspec dependency section can fail. To avoid that, the project
+generates an intermediate nuspec before `GenerateNuspec`:
 
 - Template nuspec: `tools/specs/Microsoft.Data.SqlClient.nuspec`
 - Generated nuspec: `obj/Microsoft.Data.SqlClient.pack.nuspec`
@@ -40,40 +46,53 @@ This keeps layout parity with the existing nuspec while using `dotnet pack` end-
 
 ## Known SDK behavior and repro
 
-Passing all tokens through `NuspecProperties` looks correct, but this command fails on SDK `10.0.107`:
+Passing all tokens through `NuspecProperties` looks correct, but this command fails on SDK
+`10.0.107`:
 
 ```bash
 dotnet pack src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj --no-build -p:Configuration=Debug -p:ReferenceType=Project -p:NuspecFile=<repo>/tools/specs/Microsoft.Data.SqlClient.nuspec -p:NuspecBasePath=<repo>/tools/specs -p:NuspecProperties="COMMITID=abc;Configuration=Debug;ReferenceType=Project;AbstractionsPackageVersion=1.0.0-dev;LoggingPackageVersion=1.0.0-dev" -p:NuspecVersion=7.1.0-preview1-dev -p:PackageOutputPath=<repo>/artifacts/tmp -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
 ```
 
-To reproduce this failure in the current branch and exercise the workaround, also pass the required MSBuild properties:
+To reproduce this failure in the current branch and exercise the workaround, you can still pass the
+direct project properties explicitly:
 
 ```bash
 dotnet pack src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj --no-build -p:Configuration=Debug -p:ReferenceType=Project -p:AbstractionsPackageVersion=1.0.0-dev -p:LoggingPackageVersion=1.0.0-dev -p:NuspecVersion=7.1.0-preview1-dev -p:PackageOutputPath=<repo>/artifacts/tmp -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
 ```
 
-Note: `PackageVersionAbstractions` and `PackageVersionLogging` are `build.proj` entrypoint properties and are translated to `AbstractionsPackageVersion` and `LoggingPackageVersion` for direct project pack.
+Note: `PackageVersionAbstractions` and `PackageVersionLogging` are `build.proj` entrypoint
+properties. Direct project pack can instead pass `AbstractionsPackageVersion` and
+`LoggingPackageVersion`, or omit them and let the project evaluate sibling defaults.
 
-The `PrepareSqlClientPackNuspec` target will materialize the tokens into an intermediate nuspec, bypassing the SDK's substitution bug.
+The `PrepareSqlClientPackNuspec` target will materialize the tokens into an intermediate nuspec,
+bypassing the SDK's substitution bug.
 
 Observed error (without workaround):
 
 - `An error occurred while trying to parse the value '' of property 'dependencies' in the manifest file.`
 - `'' is not a valid version string.`
 
-The same flow succeeds when dependency tokens are pre-materialized into the intermediate nuspec by `PrepareSqlClientPackNuspec`.
+The same flow succeeds when dependency tokens are pre-materialized into the intermediate nuspec by
+`PrepareSqlClientPackNuspec`.
 
 ## Related upstream issues
 
-The behavior appears related to long-standing SDK/NuGet pack substitution issues when using nuspec files with `dotnet pack`:
+The behavior appears related to long-standing SDK/NuGet pack substitution issues when using nuspec
+files with `dotnet pack`:
 
-- [dotnet/sdk#15482](https://github.com/dotnet/sdk/issues/15482) (open): multiple `NuspecProperties` values, only first substituted and others become empty.
-- [dotnet/sdk#29661](https://github.com/dotnet/sdk/issues/29661) (closed as duplicate): same symptom on SDK 6.0.404.
-- [dotnet/sdk#10516](https://github.com/dotnet/sdk/issues/10516) (closed): `dotnet pack` with nuspec not filling tokens like `$version$`.
-- [dotnet/sdk#15407](https://github.com/dotnet/sdk/issues/15407) (closed): `$configuration$` empty when packing with nuspec.
-- [dotnet/sdk#16816](https://github.com/dotnet/sdk/issues/16816) (closed): nuspec token/path behavior inconsistencies with `dotnet pack`.
+- [dotnet/sdk#15482](https://github.com/dotnet/sdk/issues/15482) (open): multiple `NuspecProperties`
+  values, only first substituted and others become empty.
+- [dotnet/sdk#29661](https://github.com/dotnet/sdk/issues/29661) (closed as duplicate): same symptom
+  on SDK 6.0.404.
+- [dotnet/sdk#10516](https://github.com/dotnet/sdk/issues/10516) (closed): `dotnet pack` with nuspec
+  not filling tokens like `$version$`.
+- [dotnet/sdk#15407](https://github.com/dotnet/sdk/issues/15407) (closed): `$configuration$` empty
+  when packing with nuspec.
+- [dotnet/sdk#16816](https://github.com/dotnet/sdk/issues/16816) (closed): nuspec token/path
+  behavior inconsistencies with `dotnet pack`.
 
-These links do not prove this exact dependency-token timing path is identical, but they strongly indicate related substitution behavior in the same pack surface area.
+These links do not prove this exact dependency-token timing path is identical, but they strongly
+indicate related substitution behavior in the same pack surface area.
 
 ## Where pack properties are defined
 
@@ -87,7 +106,8 @@ The `build.proj` target passes dynamic values only:
 - `PackageOutputPath`
 - plus standard version/reference-type arguments
 
-Note: `NuspecVersion` is derived from `$(Version)` by SDK defaults and does not need to be explicitly passed.
+Note: `NuspecVersion` is derived from `$(Version)` by SDK defaults and does not need to be
+explicitly passed.
 
 ## Outputs