dotnet pack pdb files by default

[ctaggart]

by adding .pdb to AllowedOutputExtensionsInPackageBuildOutputFolder #282

Related links:

• msbuild /t:Pack always creates seperate symbols package msbuild /t:Pack always creates seperate symbols package NuGet/Home#4142
• Improve NuGet package debugging and symbols experience Improve NuGet package debugging and symbols experience NuGet/Home#6104

dotnet pack and msbuild /t:pack do not include the pdb files by default. As of Visual Studio 2017 15.4 or .NET Core 2.0.2 SDK and above, you can fix this by modifying this property:

<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>

We may automatically set that property in the next version of SourceLink, see issue #282.

The previous recommended way of including them was to use the extension point designed for including content that is different for each target framework:

<PropertyGroup>
  <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);IncludePDBsInPackage</TargetsForTfmSpecificContentInPackage>
</PropertyGroup>
<Target Name="IncludePDBsInPackage" Condition="'$(IncludeBuildOutput)' != 'false'">
  <ItemGroup>
    <TfmSpecificPackageFile Include="$(OutputPath)\$(AssemblyName).pdb" PackagePath="lib\$(TargetFramework)" />
  </ItemGroup>
</Target>

[ctaggart]

This isn't working for me with my tests just now here:
https://github.com/ctaggart/sourcelink-test

Some notes:
PS C:\Users\camer\cs\sourcelink-test\VS2017CSharpLibraryCore> dotnet nuget --version
NuGet Command Line
4.5.0.4

<AllowedOutputExtensionsInPackageBuildOutputFolder>.dll; .exe; .winmd; .json; .pri; .xml; $(AllowedOutputExtensionsInPackageBuildOutputFolder)</AllowedOutputExtensionsInPackageBuildOutputFolder>

https://github.com/NuGet/NuGet.Client/blob/release-4.5.0-rtm/src/NuGet.Core/NuGet.Build.Tasks.Pack/Pack.targets

[jnm2]

Using the structured log viewer, I see that nothing I do in the NuGet-imported .props and .targets seems to have any effect on the Pack MSBuild invocation. It affects all the invocations that Pack depends on, but not Pack itself.

@nguerrera Are you able to give us some pointers on how to manipulate the Pack target from .props imported from NuGet packages? Thanks!

[jnm2]

I see this if I preprocess the .csproj:

  <ImportGroup Condition=" '$(TargetFramework)' == 'net461' AND '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b626\build\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b626\build\SourceLink.Embed.PaketFiles.props')" />
  </ImportGroup>
  <ImportGroup Condition=" '$(TargetFramework)' == 'netstandard1.4' AND '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b626\build\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b626\build\SourceLink.Embed.PaketFiles.props')" />
  </ImportGroup>

That means the .props is not imported from the NuGet package unless there is a TargetFramework property equal to net461. But at pack time, there is no single target framework and so of course there is no TargetFramework property. There is only TargetFrameworks equal to netstandard1.4;net461. So the .props isn't even getting included. I don't see any recourse we could take. It's not like your .props is in /build/net461; it's in /build.

[ctaggart]

Thanks @jnm2,

I troubleshot this today with ctaggart/sourcelink-test@3a8feea and you are indeed correct. It is working with TargetFramework, but not TargetFrameworks. :-(

It currently produces:

  <ImportGroup Condition=" '$(TargetFramework)' == 'net461' AND '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props')" />
    <Import Project="$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props')" />
  </ImportGroup>
  <ImportGroup Condition=" '$(TargetFramework)' == 'netstandard1.4' AND '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props')" />
    <Import Project="$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props')" />
  </ImportGroup>

If it also added a condition for when TargetFramework is empty, it would work:

  <ImportGroup Condition=" '$(TargetFramework)' == '' AND '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props')" />
    <Import Project="$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props')" />
  </ImportGroup>

[jnm2]

Yes. Even better:

  <ImportGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b631\build\SourceLink.Embed.PaketFiles.props')" />
    <Import Project="$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b631\build\SourceLink.Create.CommandLine.props')" />
  </ImportGroup>

And only use '$(TargetFramework)' == 'net461' when the .props is under /build/net461.

[jnm2]

Could you open an issue at https://github.com/dotnet/sdk, maybe?

[ctaggart]

I'll open up an issue in https://github.com/NuGet/Home. I think that is the right spot.

[ctaggart]

Yay, buildCrossTargeting works for TargetFrameworks. It adds:

  <ImportGroup Condition=" '$(TargetFramework)' == '' AND '$(ExcludeRestorePackageImports)' != 'true' ">
    <Import Project="$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b637\buildCrossTargeting\SourceLink.Embed.PaketFiles.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.embed.paketfiles\2.7.0-b637\buildCrossTargeting\SourceLink.Embed.PaketFiles.props')" />
    <Import Project="$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b637\buildCrossTargeting\SourceLink.Create.CommandLine.props" Condition="Exists('$(NuGetPackageRoot)sourcelink.create.commandline\2.7.0-b637\buildCrossTargeting\SourceLink.Create.CommandLine.props')" />
  </ImportGroup>

[jnm2]

Nice to know! I'm embarrassed that I forgot that existed. 😆