Move symbol publishing into a dedicated stage and refactor build artifacts by paulmedynski · Pull Request #4175 · dotnet/SqlClient

paulmedynski · 2026-04-09T19:49:59Z

Summary

Extract symbol publishing from build jobs into a new publish_symbols stage (publish-symbols-stage.yml) with per-package jobs (publish-symbols-job.yml)
Reorganize JOB_OUTPUT subdirectories: assemblies/ (APIScan), packages/ (NuGet), symbols/ (PDBs shared by APIScan and symbol publishing)
Point APIScan at JOB_OUTPUT/assemblies and JOB_OUTPUT/symbols instead of separate apiScan/ tree; remove copy-apiscan-files-sqlclient-step.yml
Rename PACK_OUTPUT → JOB_OUTPUT, PACK_INPUT → JOB_INPUT for clarity
Extract inline PowerShell into Publish-Symbols.ps1 with structured error handling; add Pester tests
Rename variable group symbols-variables-v2 → Symbols Publishing
Remove artifactPath variable from validate job in favor of packagesPath
Append $(System.JobAttempt) to symbol artifact names for retry safety
Guard publish_symbols stage against empty runs when no packages were built
Use environment-specific symbols publishing variables: non-official pipeline targets PPE (SymbolsPublishServerPPE, SymbolsPublishTokenUriPPE), official pipeline targets Prod (SymbolsPublishServerProd, SymbolsPublishTokenUriProd)

Checklist

Tests added or updated (Pester tests for Publish-Symbols.ps1)
Pipeline instructions updated
Verified against non-official pipeline run

Copilot

Pull request overview

This PR refactors the OneBranch pipeline artifact layout and moves symbol publishing out of individual build jobs into a dedicated publish_symbols stage, aligning APIScan and symbol publishing to consume standardized JOB_OUTPUT subfolders.

Changes:

Introduces a dedicated publish_symbols stage with per-package symbol publishing jobs, driven by a shared step/script.
Renames PACK_INPUT/PACK_OUTPUT to JOB_INPUT/JOB_OUTPUT and reorganizes outputs into assemblies/, packages/, and symbols/.
Updates build/release/validation templates to consume packages from packages/ and symbols from symbols/, removing the old SqlClient APIScan copy step.

Reviewed changes

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

Show a summary per file

File	Description
eng/pipelines/onebranch/variables/onebranch-variables.yml	Switches symbol credentials variable group reference to `Symbols Publishing`.
eng/pipelines/onebranch/variables/common-variables.yml	Renames PACK_* vars to JOB_* and documents new JOB_OUTPUT subfolder conventions.
eng/pipelines/onebranch/steps/tests/README.md	Adds documentation for running Pester tests for symbol publishing script.
eng/pipelines/onebranch/steps/tests/Publish-Symbols.Tests.ps1	Adds Pester tests validating Publish-Symbols behavior via mocks.
eng/pipelines/onebranch/steps/Publish-Symbols.ps1	Extracts symbol publishing logic into a standalone script with structured error handling.
eng/pipelines/onebranch/steps/publish-symbols-step.yml	Refactors publish step to call the extracted script and adds `symbolsFolder` parameter.
eng/pipelines/onebranch/steps/pack-sqlclient-step.yml	Copies SqlClient NuGet outputs into `$(JOB_OUTPUT)/packages`.
eng/pipelines/onebranch/steps/pack-csproj-step.yml	Packs csproj-based packages into `$(JOB_OUTPUT)/packages`.
eng/pipelines/onebranch/steps/copy-apiscan-files-sqlclient-step.yml	Removes legacy APIScan file copy step (deleted).
eng/pipelines/onebranch/stages/release-stages.yml	Updates release stage to push packages from the `packages/` subdirectory.
eng/pipelines/onebranch/stages/publish-symbols-stage.yml	Adds new stage template to publish symbols per package from downloaded build artifacts.
eng/pipelines/onebranch/stages/build-stages.yml	Removes in-job symbol publishing parameters and job wiring (moved to stage).
eng/pipelines/onebranch/sqlclient-official.yml	Wires in the new `publish-symbols-stage.yml` between build and release stages.
eng/pipelines/onebranch/sqlclient-non-official.yml	Wires in the new `publish-symbols-stage.yml` between build and release stages.
eng/pipelines/onebranch/jobs/validate-signed-package-job.yml	Updates validation job to locate packages under `<artifact>/packages`.
eng/pipelines/onebranch/jobs/publish-symbols-job.yml	Adds per-package symbols publishing job template (download artifact + publish step).
eng/pipelines/onebranch/jobs/publish-nuget-package-job.yml	Updates release job to treat packages as living under `packages/` within artifacts.
eng/pipelines/onebranch/jobs/build-signed-sqlclient-package-job.yml	Updates APIScan folder vars and copies DLLs/PDBs into JOB_OUTPUT subfolders; removes symbol publishing.
eng/pipelines/onebranch/jobs/build-signed-csproj-package-job.yml	Updates APIScan folder vars and copies DLLs/PDBs into JOB_OUTPUT subfolders; removes symbol publishing.
.github/instructions/onebranch-pipeline-design.instructions.md	Updates OneBranch pipeline design docs for new symbols stage and artifact layout.

…facts - Extract symbol publishing from build jobs into a new publish_symbols stage (publish-symbols-stage.yml) with per-package jobs (publish-symbols-job.yml) - Reorganize JOB_OUTPUT subdirectories: assemblies/ (APIScan), packages/ (NuGet), symbols/ (PDBs shared by APIScan and symbol publishing) - Point APIScan at JOB_OUTPUT/assemblies and JOB_OUTPUT/symbols instead of separate apiScan/ tree; remove copy-apiscan-files-sqlclient-step.yml - Rename PACK_OUTPUT -> JOB_OUTPUT, PACK_INPUT -> JOB_INPUT for clarity - Extract inline PowerShell into Publish-Symbols.ps1 with structured error handling; add Pester tests - Rename variable group symbols-variables-v2 -> Symbols Publishing - Remove artifactPath variable from validate job in favor of packagesPath - Append $(System.JobAttempt) to symbol artifact names for retry safety - Guard publish_symbols stage against empty runs when no packages were built

Copilot

Pull request overview

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

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

…hProjectName

…ols jobs - Add canonical docs link and two-step process documentation to publish-symbols-step.yml and publish-symbols.ps1 - Rename task display names to Step 1/Step 2 for clarity - Disable APIScan and BinSkim in publish-symbols-job.yml since symbols jobs only upload/publish PDBs with no assemblies to scan

Copilot

Pull request overview

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

- Update packagePath docs in publish-nuget-package-job.yml to reflect packages/ subdirectory layout and clarify .snupkg handling - Fix README.md test file name casing (Publish-Symbols -> publish-symbols) - Fix README.md repo-root path (steps/tests -> scripts/tests)

apoorvdeshmukh

Changes look good based on this run.
As agreed earlier, we can merge this once the symbols account setup is complete.

paulmedynski · 2026-04-15T17:21:03Z

The backend work has been completed, and symbol publishing is working>

https://sqlclientdrivers.visualstudio.com/ADO.Net/_build/results?buildId=147410&view=results

Non-official pipeline now uses SymbolsPublishServerPPE and SymbolsPublishTokenUriPPE. Official pipeline uses the Prod variants.

Copilot

Pull request overview

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

…ing.

paulmedynski · 2026-04-16T22:01:12Z

Successful run using PPE for symbols publishing is here:

https://sqlclientdrivers.visualstudio.com/ADO.Net/_build/results?buildId=148117&view=results

- Update SymbolsPublishServer/SymbolsPublishTokenUri to their actual suffixed names (Prod/PPE) in onebranch-variables.yml header comment - Fix Publish-Symbols.ps1 -> publish-symbols.ps1 casing in onebranch-pipeline-design.instructions.md

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

mdaigle · 2026-04-16T22:46:52Z

+              symbolsUploadAccount: '${{ parameters.symbolsUploadAccount }}'
+
+        # ── AKV Provider ───────────────────────────────────────────────
+        - ${{ if and(eq(parameters.buildAkvProvider, true), eq(parameters.buildSqlClient, true)) }}:


Why is this condition an and?

paulmedynski added this to the 7.1.0-preview1 milestone Apr 9, 2026

Copilot AI review requested due to automatic review settings April 9, 2026 19:50

github-project-automation bot added this to SqlClient Board Apr 9, 2026

github-project-automation bot moved this to To triage in SqlClient Board Apr 9, 2026

Copilot started reviewing on behalf of paulmedynski April 9, 2026 19:50 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

paulmedynski force-pushed the dev/paul/symbols-publishing branch from 0dccecb to bbf6303 Compare April 10, 2026 11:18

Address PR review: fix dependsOn, align comments, fix step count

98aaeef

Copilot AI review requested due to automatic review settings April 10, 2026 11:22

paulmedynski moved this from To triage to In progress in SqlClient Board Apr 10, 2026

Copilot started reviewing on behalf of paulmedynski April 10, 2026 11:23 View session

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/scripts/publish-symbols.ps1

Comment thread eng/pipelines/onebranch/scripts/tests/README.md

Fail task on terminal symbol publishing failures, add tests

c387515

paulmedynski moved this from In progress to In review in SqlClient Board Apr 10, 2026

paulmedynski marked this pull request as ready for review April 10, 2026 12:02

paulmedynski requested a review from a team as a code owner April 10, 2026 12:02

Copilot AI review requested due to automatic review settings April 10, 2026 12:02

paulmedynski added the Hotfix Candidate 🚑 Issues/PRs that are candidate for backporting to earlier supported versions. label Apr 10, 2026

Copilot started reviewing on behalf of paulmedynski April 10, 2026 12:03 View session

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/jobs/publish-nuget-package-job.yml

paulmedynski added 2 commits April 10, 2026 10:52

Use pwsh for symbol publishing and fix non-ASCII character

8167569

Move and rename publish-symbols script to onebranch/scripts

9ceff58

Copilot AI review requested due to automatic review settings April 10, 2026 13:56

Copilot started reviewing on behalf of paulmedynski April 10, 2026 13:56 View session

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/scripts/tests/README.md

paulmedynski added 2 commits April 10, 2026 12:48

Fix status property names to match API response, rename SymbolsPublis…

75cdb27

…hProjectName

Copilot AI review requested due to automatic review settings April 10, 2026 18:26

Copilot started reviewing on behalf of paulmedynski April 10, 2026 18:27 View session

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/scripts/tests/README.md

Comment thread eng/pipelines/onebranch/scripts/tests/README.md Outdated

This was referenced Apr 13, 2026

[7.0] Extract Publish-Symbols.ps1 script and add retry safety for symbol publishing #4174

Closed

[6.1] Fix symbol publishing connectivity and extract into testable script #4171

Closed

apoorvdeshmukh previously approved these changes Apr 14, 2026

View reviewed changes

paulmedynski added the Hotfix 6.1.5 label Apr 15, 2026

paulmedynski mentioned this pull request Apr 15, 2026

Add OneBranch pipelines for 6.1 branch #4197

Draft

4 tasks

cheenamalhotra reviewed Apr 15, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/sqlclient-non-official.yml Outdated

Use PPE/Prod symbols publishing variables

65907ed

Non-official pipeline now uses SymbolsPublishServerPPE and SymbolsPublishTokenUriPPE. Official pipeline uses the Prod variants.

Copilot AI review requested due to automatic review settings April 16, 2026 15:19

paulmedynski dismissed apoorvdeshmukh’s stale review via 65907ed April 16, 2026 15:19

Copilot started reviewing on behalf of paulmedynski April 16, 2026 15:20 View session

Copilot AI reviewed Apr 16, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/variables/onebranch-variables.yml Outdated

Comment thread .github/instructions/onebranch-pipeline-design.instructions.md Outdated

Added comments to explain the intention of PPE vs Prod symbol publish…

f04f1fc

…ing.

Copilot AI review requested due to automatic review settings April 16, 2026 22:02

paulmedynski enabled auto-merge (squash) April 16, 2026 22:02

Copilot started reviewing on behalf of paulmedynski April 16, 2026 22:02 View session

Copilot AI reviewed Apr 16, 2026

View reviewed changes

Comment thread eng/pipelines/onebranch/jobs/publish-nuget-package-job.yml

mdaigle reviewed Apr 16, 2026

View reviewed changes

Conversation

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

Uh oh!

Summary

Checklist

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!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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!

apoorvdeshmukh left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski commented Apr 15, 2026

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!

paulmedynski commented Apr 16, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

mdaigle Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

paulmedynski commented Apr 9, 2026 •

edited

Loading