Change AKV Provider to target .NET Standard 2.0 by paulmedynski · Pull Request #4016 · dotnet/SqlClient

paulmedynski · 2026-03-06T15:52:08Z

Description

This PR changes the AKV Provider to target .NET Standard 2.0 since it doesn't contain any code specific to .NET or .NET Framework. Changes include:

AKV Provider Changes:
- Explicitly set <TargetFramework> to netstandard2.0 in the AKV Provider project.
- Removed the add-ons/Directory.Build.props.
- Absorbed the AKV Provider nuspec into the csproj.
Build Changes:
- Added new BuildAkvProvider and PackAkvProvider targets to build.proj.
- Removed all of the obsolete AKV Provider build targets.
- Removed the GenerateAkvPackage target and all references to it.
- Added BuildAllPackages and PackAllPackages targets.
- Added BuildSqlClient and PackSqlClient targets to help fix the Docs-Build-Pack-Publish pipeline.
Pipeline Changes:
- Updated pipelines to pack the AKV Provider directly.

Testing

Automated PR runs will confirm basic functionality.
Manual CI run will confirm those pipeline changes.
Manual OneBranch pipeline runs will confirm official builds.
Maunal runs of the Docs-Build-Pack-Publish pipeline to confirm fixes there.

…d up NuGet packing.

eng/pipelines/common/templates/jobs/ci-build-nugets-job.yml

eng/pipelines/onebranch/jobs/build-akv-official-job.yml

paulmedynski · 2026-03-06T15:54:44Z

.../AzureKeyVaultProvider/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.csproj

    <DocumentationFile>$(BinFolder)$(Configuration).$(Platform)\$(AssemblyName).xml</DocumentationFile>
  </PropertyGroup>

-  <!-- Trim/AOT Support ================================================ -->


.NET Standard 2.0 isn't trimmable or AOT compatible.

paulmedynski · 2026-03-06T15:55:07Z

.../AzureKeyVaultProvider/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.csproj

-    <IsTrimmable>true</IsTrimmable>
-    <IsAotCompatible>true</IsAotCompatible>
+  <ItemGroup>
+    <EmbeddedFiles Include="$(GeneratedAssemblyInfoFile)"/>


Moved here from the deleted Directory.Build.props.

paulmedynski · 2026-03-06T15:55:35Z

.../AzureKeyVaultProvider/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.csproj

+
+    See: https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#pack-target
+  -->
+  <PropertyGroup>


Absorbed from the nuspec, thanks to Copilot.

paulmedynski · 2026-03-06T15:56:37Z

.../AzureKeyVaultProvider/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.csproj

  <!-- MDS Reference -->
  <ItemGroup>
-    <ProjectReference Include="$(RepoRoot)src\Microsoft.Data.SqlClient\src\Microsoft.Data.SqlClient.csproj"
+    <ProjectReference Include="$(RepoRoot)/src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.csproj"


The SqlClient project doesn't target .NET Standard 2.0, but it's ref project does. We don't need a real implementation to compile against.

paulmedynski · 2026-03-06T15:57:20Z

tools/specs/Microsoft.Data.SqlClient.nuspec

    <readme>README.md</readme>
    <repository type="git" url="https://github.com/dotnet/sqlclient" commit="$COMMITID$" />
-    <description>The current data provider for SQL Server and Azure SQL databases. This has replaced System.Data.SqlClient. These classes provide access to SQL and encapsulate database-specific protocols, including tabular data stream (TDS).
+    <description>


Formatting cleanup.

build.proj

Copilot

Pull request overview

This PR updates the Always Encrypted Azure Key Vault (AKV) Provider to target .NET Standard 2.0 and modernizes its packaging flow by moving from a standalone .nuspec/custom MSBuild target to SDK-style dotnet pack driven by the AKV Provider .csproj. It also updates build/pipeline wiring to use the new BuildAkvProvider/PackAkvProvider targets.

Changes:

Removed the legacy AKV .nuspec and GenerateAkvPackage MSBuild target infrastructure.
Updated the AKV Provider project to netstandard2.0 and embedded NuGet metadata into the .csproj.
Updated build and pipeline steps to build/pack the AKV Provider directly via dotnet pack and new build.proj targets.

Reviewed changes

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

Show a summary per file

File	Description
tools/targets/add-ons/GenerateAkvPackage.targets	Removes the legacy `GenerateAkvPackage` target.
tools/specs/add-ons/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.nuspec	Deletes the old AKV Provider `.nuspec` (packaging now via `.csproj`).
tools/specs/Microsoft.Data.SqlClient.nuspec	Adds a header comment documenting required `nuget pack` properties (contains a small typo).
src/Microsoft.Data.SqlClient/add-ons/Directory.Build.props	Removes add-ons-specific props file (AKV now uses standard props chain).
src/Microsoft.Data.SqlClient/add-ons/AzureKeyVaultProvider/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.csproj	Sets `netstandard2.0` and absorbs NuGet package metadata/config into the project.
eng/pipelines/onebranch/variables/common-variables.yml	Removes `akvNuspecPath` variable (no longer applicable).
eng/pipelines/onebranch/steps/roslyn-analyzers-akv-step.yml	Updates build target from `BuildAkv` to `BuildAkvProvider`.
eng/pipelines/onebranch/steps/compound-build-akv-step.yml	Updates build target naming/usage to `BuildAkvProvider`.
eng/pipelines/onebranch/jobs/build-akv-official-job.yml	Switches AKV packaging step from nuspec-based to `dotnet pack` on the `.csproj`.
eng/pipelines/common/templates/steps/ci-project-build-step.yml	Replaces old AKV build targets with `BuildAkvProvider` (but introduces a Windows gating issue).
eng/pipelines/common/templates/jobs/ci-build-nugets-job.yml	Switches AKV packaging from nuspec-based step to `dotnet pack` on the `.csproj`.
build.proj	Removes `GenerateAkvPackage.targets` import; adds `BuildAkvProvider`/`PackAkvProvider`; updates BuildSqlClient deps.
BUILDGUIDE.md	Documents the new `BuildAkvProvider`/`PackAkvProvider` targets and removes obsolete AKV targets.

Comments suppressed due to low confidence (1)

src/Microsoft.Data.SqlClient/add-ons/AzureKeyVaultProvider/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.csproj:78

Switching AKV Provider packaging from a nuspec to SDK-style dotnet pack means the project’s PackageReferences/ProjectReferences now flow into the produced NuGet dependency graph. This project currently references Microsoft.Data.SqlClient.Extensions.Logging, which the removed nuspec did not list, so this change will add/alter external package dependencies for consumers. If the AKV provider doesn’t actually use Logging APIs, remove that reference or mark it as PrivateAssets=all to avoid changing the published dependency set.

  <!-- References ====================================================== -->
  <!-- MDS Reference -->
  <ItemGroup>
    <ProjectReference Include="$(RepoRoot)/src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.csproj"
                      Condition="'$(ReferenceType)' != 'Package'" />
    <PackageReference Include="Microsoft.Data.SqlClient"
                      Condition="'$(ReferenceType)' == 'Package'" />
  </ItemGroup>

You can also share your feedback on Copilot code review. Take the survey.

eng/pipelines/common/templates/steps/ci-project-build-step.yml

tools/specs/Microsoft.Data.SqlClient.nuspec

BUILDGUIDE.md

…argets.

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

tools/props/Versions.props

tools/specs/Microsoft.Data.SqlClient.nuspec

BUILDGUIDE.md

codecov · 2026-03-06T20:45:00Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.48%. Comparing base (569ada7) to head (bc19a3a).

❗ There is a different number of reports uploaded between BASE (569ada7) and HEAD (bc19a3a). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (569ada7) HEAD (bc19a3a)

CI-SqlClient 1 0

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4016      +/-   ##
==========================================
- Coverage   72.36%   64.48%   -7.88%     
==========================================
  Files         287      282       -5     
  Lines       43149    66073   +22924     
==========================================
+ Hits        31223    42610   +11387     
- Misses      11926    23463   +11537

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

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.

…y to inhibit NuGet.exe download when generating SqlClient package.

paulmedynski · 2026-03-06T20:57:33Z

tools/targets/GenerateMdsPackage.targets


+  <!-- We will download the latest NuGet executable unless otherwise inhibited. -->
+  <PropertyGroup>
+    <InstallNuget Condition="'$(InstallNuget)' != 'false'">true</InstallNuget>


The Docs-Build-Pack-Publish pipeline isn't permitted to download things, so it will set this to false.

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

build.proj

tools/targets/GenerateMdsPackage.targets

…e to use.

Converted AKV Provider project to target .NET Standard 2.0 and cleane…

c7c0fba

…d up NuGet packing.

Copilot AI review requested due to automatic review settings March 6, 2026 15:52

paulmedynski added the Area\AKV Provider Use this label to tag issues that are targeted for AKV Provider codebase. label Mar 6, 2026

github-project-automation bot added this to SqlClient Board Mar 6, 2026

github-project-automation bot moved this to To triage in SqlClient Board Mar 6, 2026

paulmedynski moved this from To triage to In progress in SqlClient Board Mar 6, 2026

Copilot started reviewing on behalf of paulmedynski March 6, 2026 15:52 View session

paulmedynski commented Mar 6, 2026

View reviewed changes

Copilot AI reviewed Mar 6, 2026

View reviewed changes

eng/pipelines/common/templates/steps/ci-project-build-step.yml Show resolved Hide resolved

tools/specs/Microsoft.Data.SqlClient.nuspec Outdated Show resolved Hide resolved

BUILDGUIDE.md Outdated Show resolved Hide resolved

paulmedynski added 2 commits March 6, 2026 14:30

Addressed comments from the PR.

87b18f1

Fixed csproj-based default version numbers and SqlClient build/pack t…

9da7ec5

…argets.

Copilot AI review requested due to automatic review settings March 6, 2026 19:27

Copilot started reviewing on behalf of paulmedynski March 6, 2026 19:27 View session

Copilot AI reviewed Mar 6, 2026

View reviewed changes

tools/props/Versions.props Show resolved Hide resolved

tools/specs/Microsoft.Data.SqlClient.nuspec Outdated Show resolved Hide resolved

BUILDGUIDE.md Outdated Show resolved Hide resolved

Addressed more PR comments.

bc19a3a

Fixed pipeline use of PackAkvProvider, and added InstallNuget propert…

b2d970a

…y to inhibit NuGet.exe download when generating SqlClient package.

Copilot AI review requested due to automatic review settings March 6, 2026 20:53

Copilot started reviewing on behalf of paulmedynski March 6, 2026 20:54 View session

paulmedynski commented Mar 6, 2026

View reviewed changes

Copilot AI reviewed Mar 6, 2026

View reviewed changes

build.proj Outdated Show resolved Hide resolved

tools/targets/GenerateMdsPackage.targets Show resolved Hide resolved

Fixing how/when we generate SqlClient nuget and which NuGet executabl…

86dcd3c

…e to use.

Conversation

paulmedynski commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Uh oh!

Uh oh!

Uh oh!

paulmedynski Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Mar 6, 2026

Codecov Report

Uh oh!

paulmedynski Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

paulmedynski commented Mar 6, 2026 •

edited

Loading