Migrate SqlClient packaging to dotnet pack and centralize pack fallback

[paulmedynski]

Summary

• switch PackSqlClient from nuget.exe pack to dotnet pack
• move SqlClient pack configuration into src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj
• generate an intermediate nuspec so dependency version tokens and $Version$ are materialized before SDK pack runs
• move Abstractions/Logging sibling version fallback into the SqlClient project so direct project pack can evaluate defaults without requiring build.proj to precompute them
• simplify build.proj PackSqlClient so it forwards pack inputs and lets the SqlClient project own SqlClient-specific pack behavior
• update the remaining nuget pack pipeline template to pass Version via -properties
• refresh BUILDGUIDE.md, TESTGUIDE.md, and src/Microsoft.Data.SqlClient/src/sqlclient-dotnet-pack.md, and address the Copilot review follow-ups for property naming, repro docs, and nuspec token details

Validation

• built SqlClient artifacts with dotnet msbuild build.proj -t:BuildSqlClient
• packed this branch with dotnet msbuild build.proj -t:PackSqlClient -p:PackBuild=false
• packed main using nuget.exe pack against the same built artifacts for comparison
• compared both .nupkg files after extraction
• verified all 52 DLLs are byte-for-byte identical between the two packages
• confirmed the only package differences are packaging-tool metadata (repository commit, lastModifiedBy, and derived relationship/core-properties identifiers)
• smoke-tested the follow-up fallback path with dotnet msbuild src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj -t:PrepareSqlClientPackNuspec -p:ReferenceType=Project -p:BuildNumber=1234 -p:BuildSuffix=dev -p:SqlClientPackageVersion=7.1.0-preview1-dev1234

Notes

• no public API changes
• no test files were changed; this PR is scoped to packaging, pipeline, and documentation behavior
• package content and dependency metadata remain functionally equivalent to main

[Copilot]

Pull request overview

Migrates Microsoft.Data.SqlClient packaging from nuget.exe pack to an SDK-driven dotnet pack flow, moving pack configuration into the main project and introducing an intermediate nuspec generation step to avoid SDK/NuGet token-substitution issues for dependency versions.

Changes:

• Switch PackSqlClient from nuget.exe pack to dotnet pack in build.proj.
• Add dotnet pack/nuspec configuration to Microsoft.Data.SqlClient.csproj, including PrepareSqlClientPackNuspec to materialize dependency versions + package version into an intermediate nuspec.
• Add documentation describing the pack flow and the upstream SDK substitution behavior.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
src/Microsoft.Data.SqlClient/src/sqlclient-dotnet-pack.md	New doc describing the SDK-based pack flow, repro, and rationale for generating an intermediate nuspec.
src/Microsoft.Data.SqlClient/src/Microsoft.Data.SqlClient.csproj	Adds pack defaults and a pre-GenerateNuspec target to generate a token-expanded nuspec for dotnet pack.
build.proj	Updates PackSqlClient target to run dotnet pack and removes NugetPath/nuget.exe usage.

Comments suppressed due to low confidence (1)

build.proj:545

• GetSqlClientPackageVersionCommand uses dotnet build ... -getProperty:SqlClientPackageVersion. -getProperty is an MSBuild switch and may be rejected by dotnet build argument parsing (unless forwarded via --), which would break PackSqlClient. Consider switching back to dotnet msbuild for this query, or explicitly forwarding MSBuild-only args (dotnet build ... -- -getProperty:...).

      <GetSqlClientPackageVersionCommand>
        "$(DotnetPath)dotnet" build "$(SqlClientProjectPath)"
        -nologo
        -verbosity:quiet
        -getProperty:SqlClientPackageVersion

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

[paulmedynski]

Addressing Copilot review comments from commit 2851620:

Comment on line 116 (template brittleness): Replaced hardcoded XML string replacement with dedicated $NuspecVersion$ token, matching the pattern for $COMMITID$ and other tokens. This is resilient to template formatting changes.

Comment on line 47 (repro command docs): Added clarifying text explaining the repro command demonstrates the SDK bug. Added a second example with the required -p:PackageVersionAbstractions and -p:PackageVersionLogging MSBuild properties that triggers PrepareSqlClientPackNuspec.

Comment on line 51 (spelling): Fixed 'occured' → 'occurred'.

Comment in BUILDGUIDE.md (grammar): Fixed 'bulding' → 'building' and 'also handle by' → 'also handled by'.

Comment on line 80 (NuspecVersion): Clarified that NuspecVersion is derived from $(Version) by SDK defaults and removed it from the dynamic values list.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.39%. Comparing base (b1c082e) to head (b52b37a).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4257      +/-   ##
==========================================
- Coverage   65.95%   64.39%   -1.56%     
==========================================
  Files         276      270       -6     
  Lines       42981    65777   +22796     
==========================================
+ Hits        28346    42357   +14011     
- Misses      14635    23420    +8785     

Flag	Coverage Δ
CI-SqlClient	?
PR-SqlClient-Project	64.39% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

[apoorvdeshmukh]

LGTM overall. Branch has some expected conflicts that need to be resolved and copilot has some doc comments that can be considered.

[Copilot]

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.

[Copilot]

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

[benrr101]

I guess it's good 🤷‍♂️
I'm a bit sketched out by all the magic that's going on with known-but-unknown build targets, known-but-unknown properties, etc. I almost think its better to just keep using nuget.exe since it's clearer what's going on rather than shoehorning the behavior into dotnet pack. But it is nice to not have to have a separate nuget.exe file to do everything.

The "right" way to do this is to eliminate os-specific builds, eliminate the ref and unsupported projects, and then eliminate the nuspec file. But ... that's a lot longer of a process, and idk if we'll ever get funding for it. Anyways, just know I'm uneasy about this change but I'll go ahead with it.