Add the property controlling publishing the symbols of reference projects#49707
Merged
YuliiaKovalova merged 1 commit intodotnet:mainfrom Jan 7, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new PublishReferencesSymbols property to control publishing of referenced project PDB files, along with default behavior and tests.
- Added
PublishReferencesSymbolsproperty with a default value in MSBuild’s BeforeCommon targets. - Updated publish logic to conditionally include
.pdbfiles based on the new property. - Introduced a theory test to verify symbol publishing when the property is explicitly set.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/Microsoft.NET.Publish.Tests/GivenThatWeWantToPublishAProjectWithDependencies.cs | Added a theory test for PublishReferencesSymbols=true/false scenarios. |
| src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.BeforeCommon.targets | Defined <PublishReferencesSymbols> property with a default of true. |
| src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Publish.targets | Modified the copy-local asset condition to include .pdb when enabled. |
Comments suppressed due to low confidence (1)
test/Microsoft.NET.Publish.Tests/GivenThatWeWantToPublishAProjectWithDependencies.cs:280
- Consider adding a test case for the default behavior (when
PublishReferencesSymbolsisn't specified) to ensure it truly defaults totrueand PDB files are published by default.
[Theory]
Comment on lines
+706
to
711
| Condition="(('$(PublishReferencesDocumentationFiles)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.xml') | ||
| or ('$(PublishReferencesSymbols)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.pdb') | ||
| or ('%(ReferenceCopyLocalPaths.Extension)' != '.xml' and '%(ReferenceCopyLocalPaths.Extension)' != '.pdb')) | ||
| and '%(ReferenceCopyLocalPaths.Private)' != 'false'"> | ||
| <DestinationSubPath>%(ReferenceCopyLocalPaths.DestinationSubDirectory)%(ReferenceCopyLocalPaths.Filename)%(ReferenceCopyLocalPaths.Extension)</DestinationSubPath> | ||
| </_ResolvedCopyLocalPublishAssets> |
There was a problem hiding this comment.
[nitpick] This multi-line Condition is quite verbose and can be hard to maintain; consider breaking it into separate ItemGroups or using intermediate properties to clarify each inclusion rule.
Suggested change
| Condition="(('$(PublishReferencesDocumentationFiles)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.xml') | |
| or ('$(PublishReferencesSymbols)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.pdb') | |
| or ('%(ReferenceCopyLocalPaths.Extension)' != '.xml' and '%(ReferenceCopyLocalPaths.Extension)' != '.pdb')) | |
| and '%(ReferenceCopyLocalPaths.Private)' != 'false'"> | |
| <DestinationSubPath>%(ReferenceCopyLocalPaths.DestinationSubDirectory)%(ReferenceCopyLocalPaths.Filename)%(ReferenceCopyLocalPaths.Extension)</DestinationSubPath> | |
| </_ResolvedCopyLocalPublishAssets> | |
| Condition="('$(PublishReferencesDocumentationFiles)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.xml') or | |
| ('$(PublishReferencesSymbols)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.pdb') or | |
| ('%(ReferenceCopyLocalPaths.Extension)' != '.xml' and '%(ReferenceCopyLocalPaths.Extension)' != '.pdb')"> | |
| </_ResolvedCopyLocalPublishAssets> | |
| <PropertyGroup> | |
| <IsDocumentationFile Condition="'$(PublishReferencesDocumentationFiles)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.xml'">true</IsDocumentationFile> | |
| <IsSymbolFile Condition="'$(PublishReferencesSymbols)' == 'true' and '%(ReferenceCopyLocalPaths.Extension)' == '.pdb'">true</IsSymbolFile> | |
| <IsOtherFile Condition="'%(ReferenceCopyLocalPaths.Extension)' != '.xml' and '%(ReferenceCopyLocalPaths.Extension)' != '.pdb'">true</IsOtherFile> | |
| <IsPrivateFile Condition="'%(ReferenceCopyLocalPaths.Private)' != 'false'">true</IsPrivateFile> | |
| </PropertyGroup> | |
| <ItemGroup> | |
| <_ResolvedCopyLocalPublishAssets Include="@(ReferenceCopyLocalPaths)" | |
| Exclude="@(_ResolvedCopyLocalBuildAssets);@(RuntimePackAsset)" | |
| Condition="('$(IsDocumentationFile)' == 'true' or | |
| '$(IsSymbolFile)' == 'true' or | |
| '$(IsOtherFile)' == 'true') and | |
| '$(IsPrivateFile)' == 'true'"> | |
| <DestinationSubPath>%(ReferenceCopyLocalPaths.DestinationSubDirectory)%(ReferenceCopyLocalPaths.Filename)%(ReferenceCopyLocalPaths.Extension)</DestinationSubPath> | |
| </_ResolvedCopyLocalPublishAssets> | |
| </ItemGroup> | |
| <DestinationSubPath>%(ReferenceCopyLocalPaths.DestinationSubDirectory)%(ReferenceCopyLocalPaths.Filename)%(ReferenceCopyLocalPaths.Extension)</DestinationSubPath> | |
| </_ResolvedCopyLocalPublishAssets> |
Member
Author
|
@rainersigwald can you please take a look? |
Member
|
@baronfel could you please check this PR? |
baronfel
reviewed
Oct 6, 2025
src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.BeforeCommon.targets
Show resolved
Hide resolved
Member
|
I added the |
Member
Author
Please review the doc pr dotnet/docs#50255. |
YuliiaKovalova
approved these changes
Jan 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix dotnet/msbuild#12044
Add the property
PublishReferenceSymbolsto control whether the .pdb file of the referenced project is published to the publish folder.