dotnet pack pdb files by default (#291)

* dotnet pack pdb files by default by adding .pdb to AllowedOutputExtensionsInPackageBuildOutputFolder * dogfood 2.7 * buildCrossTargeting * add buildCrossTargeting to rest
ctaggart · Dec 27, 2017 · ab1fad1 · ab1fad1
1 parent 7b71b32
commit ab1fad1
Show file tree

Hide file tree

Showing 17 changed files with 110 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ The [source link documention](https://github.com/dotnet/core/blob/master/Documen
 ``` xml
 <Project>
   <ItemGroup>
-    <PackageReference Include="SourceLink.Create.CommandLine" Version="2.6.0" PrivateAssets="All" /> 
+    <PackageReference Include="SourceLink.Create.CommandLine" Version="2.7.0" PrivateAssets="All" /> 
   </ItemGroup>
 </Project>
 ```
@@ -67,7 +67,7 @@ msbuild /t:rebuild /p:ci=true /v:n
 
 Install by adding:
 ``` xml
-<DotNetCliToolReference Include="dotnet-sourcelink" Version="2.6.0" />
+<DotNetCliToolReference Include="dotnet-sourcelink" Version="2.7.0" />
 ```
 
 ## examples
@@ -76,7 +76,7 @@ Install by adding:
 
 `dotnet sourcelink test` may also be run by using the `SourceLink.Test` MSBuild targets.
 ``` xml
-<PackageReference Include="SourceLink.Test" Version="2.6.0" PrivateAssets="all" />
+<PackageReference Include="SourceLink.Test" Version="2.7.0" PrivateAssets="all" />
 ```
 Just like the `SourceLinkCreate` property, you can control when it is enabled by setting the `SourceLinkTest` property.
 
@@ -87,8 +87,8 @@ Please follow the quick start if you are just getting started. `SourceLink.Creat
 `SourceLink.Create.GitHub`, `SourceLink.Create.BitBucket` and `SourceLink.Create.BitBucketServer` use `dotnet sourcelink-git`, which accesses the git information using [libgit2sharp](https://github.com/libgit2/libgit2sharp). This allows some additional features. It verifies that all of the source files are in the git repository and that their checksums match. If checksums do not match due to line endings, it will automatically fix them to match the git repository like endings of `lf`. If a source file's checksum still does not match, it will be embedded. If the source file is not in the git repository, it will be embedded. All of these settings are configurable.
 
 ``` xml
-<PackageReference Include="SourceLink.Create.GitHub" Version="2.6.0" PrivateAssets="all" />
-<DotNetCliToolReference Include="dotnet-sourcelink-git" Version="2.6.0" />
+<PackageReference Include="SourceLink.Create.GitHub" Version="2.7.0" PrivateAssets="all" />
+<DotNetCliToolReference Include="dotnet-sourcelink-git" Version="2.7.0" />
 ```
 
 # Embedding Source Files
@@ -99,46 +99,26 @@ For source files are not committed to the repository, it is helpful to embed the
 
 If you just want to embed all of the source files in the pdb and not use source link, add this package:
 ``` xml
-<PackageReference Include="SourceLink.Embed.AllSourceFiles" Version="2.6.0" PrivateAssets="all" />
+<PackageReference Include="SourceLink.Embed.AllSourceFiles" Version="2.7.0" PrivateAssets="all" />
 ```
 
 ## Paket Files
 
 If you are using `SourceLink.Create.CommandLine` and [Paket](https://fsprojects.github.io/Paket/)'s support for including source code that is not in your repository, you can embed those files in the pdb with:
 ``` xml
-<PackageReference Include="SourceLink.Embed.PaketFiles" Version="2.6.0" PrivateAssets="all" />
+<PackageReference Include="SourceLink.Embed.PaketFiles" Version="2.7.0" PrivateAssets="all" />
 ```
 
 # Known Issues
 
-Please vote for all of these issues:
+- Private repositories are not supported
 
-- GitHub NuGet: [msbuild /t:Pack always creates seperate symbols package](https://github.com/NuGet/Home/issues/4142)
-
-  `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:
-  ``` xml
-  <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
-  ```
-
-  We may automatically set that property in the next version of SourceLink, see [issue #282](https://github.com/ctaggart/SourceLink/issues/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:
-
-  ``` xml
-  <PropertyGroup>
-    <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);IncludePDBsInPackage</TargetsForTfmSpecificContentInPackage>
-  </PropertyGroup>
-  <Target Name="IncludePDBsInPackage" Condition="'$(IncludeBuildOutput)' != 'false'">
-    <ItemGroup>
-      <TfmSpecificPackageFile Include="$(OutputPath)\$(AssemblyName).pdb" PackagePath="lib\$(TargetFramework)" />
-    </ItemGroup>
-  </Target>
-  ```
+  Visual Studio 2017 15.6 may add support. Please vote for User Voice: [Debugger should support authentication with SourceLink](https://visualstudio.uservoice.com/forums/121579-visual-studio-ide/suggestions/19107784-debugger-should-support-authentication-with-source).
 
-- Visual Studio User Voice: [Debugger should support C# compiler '/embed' option](https://visualstudio.uservoice.com/forums/121579-visual-studio-ide/suggestions/19107733-debugger-should-support-c-compiler-embed-optio)
-
-  The Visual Studio 2017 debugger does not currently look for embedded source files. The fix will ship with Visual Studio 2017 15.5.
-
-- Visual Studio User Voice: [Debugger should support authentication with SourceLink](https://visualstudio.uservoice.com/forums/121579-visual-studio-ide/suggestions/19107784-debugger-should-support-authentication-with-source)
+- dotnet pack does not include pdb files by default
+
+  Update to SourceLink 2.7.0 which [adds .pdb files](https://github.com/ctaggart/SourceLink/pull/291) to the list of files to pack.
 
-   In order to use source link with private GitHub repositories and other private repositories, it needs to support authentication.
+- Visual Studio does not debug into embedded source files
+
+  Update to Visual Studio 2017 15.5 or later. Support [was added](https://visualstudio.uservoice.com/forums/121579-visual-studio-ide/suggestions/19107733-debugger-should-support-c-compiler-embed-optio).
diff --git a/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.csproj b/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.csproj
@@ -14,6 +14,14 @@
 
   <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
   <ItemGroup Label="dotnet pack instructions">
+    <Content Include="SourceLink.Create.BitBucket.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Create.BitBucket.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Create.BitBucket.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>

diff --git a/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.props b/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.csproj b/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.csproj
@@ -14,6 +14,14 @@
 
   <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
   <ItemGroup Label="dotnet pack instructions">
+    <Content Include="SourceLink.Create.BitBucketServer.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Create.BitBucketServer.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Create.BitBucketServer.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>

diff --git a/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.props b/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.csproj b/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.csproj
@@ -22,6 +22,14 @@
 
   <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
   <ItemGroup Label="dotnet pack instructions">
+    <Content Include="SourceLink.Create.CommandLine.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Create.CommandLine.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Create.CommandLine.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>
@@ -44,7 +52,7 @@
 
   <!--<Import Project="../build/sourcelink.props" />-->
   <ItemGroup>
-    <PackageReference Include="SourceLink.Create.GitHub" Version="2.6.0" PrivateAssets="all" />
-    <DotNetCliToolReference Include="dotnet-sourcelink-git" Version="2.6.0" />
+    <PackageReference Include="SourceLink.Create.GitHub" Version="2.7.0-b626" PrivateAssets="all" />
+    <DotNetCliToolReference Include="dotnet-sourcelink-git" Version="2.7.0-b626" />
   </ItemGroup>
 </Project>
diff --git a/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.props b/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj
@@ -14,6 +14,14 @@
 
   <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
   <ItemGroup Label="dotnet pack instructions">
+    <Content Include="SourceLink.Create.GitHub.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Create.GitHub.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Create.GitHub.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>

diff --git a/SourceLink.Create.GitHub/SourceLink.Create.GitHub.props b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/SourceLink.Create.GitLab/SourceLink.Create.GitLab.csproj b/SourceLink.Create.GitLab/SourceLink.Create.GitLab.csproj
@@ -14,6 +14,14 @@
 
   <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
   <ItemGroup Label="dotnet pack instructions">
+    <Content Include="SourceLink.Create.GitLab.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Create.GitLab.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Create.GitLab.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>

diff --git a/SourceLink.Create.GitLab/SourceLink.Create.GitLab.props b/SourceLink.Create.GitLab/SourceLink.Create.GitLab.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.csproj b/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.csproj
@@ -6,6 +6,14 @@
   </PropertyGroup>
   <ItemGroup Label="dotnet pack instructions">
     <PackageReference Update="NETStandard.Library" PrivateAssets="all" />
+    <Content Include="SourceLink.Embed.AllSourceFiles.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Embed.AllSourceFiles.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Embed.AllSourceFiles.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>

diff --git a/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.props b/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.csproj b/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.csproj
@@ -6,6 +6,14 @@
   </PropertyGroup>
   <ItemGroup Label="dotnet pack instructions">
     <PackageReference Update="NETStandard.Library" PrivateAssets="all" />
+    <Content Include="SourceLink.Embed.PaketFiles.props">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="SourceLink.Embed.PaketFiles.props">
+      <Pack>true</Pack>
+      <PackagePath>buildCrossTargeting</PackagePath>
+    </Content>
     <Content Include="SourceLink.Embed.PaketFiles.targets">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>

diff --git a/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.props b/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.props
@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+</Project>
diff --git a/build/build.proj b/build/build.proj
@@ -4,6 +4,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <DotNetCliToolReference Include="dotnet-sourcelink" Version="2.6.0" />
+    <DotNetCliToolReference Include="dotnet-sourcelink" Version="2.7.0-b626" />
   </ItemGroup>
 </Project>
diff --git a/build/sourcelink.props b/build/sourcelink.props
@@ -1,5 +1,5 @@
 <Project>
   <ItemGroup>
-    <PackageReference Include="SourceLink.Create.CommandLine" Version="2.6.0" PrivateAssets="all" />
+    <PackageReference Include="SourceLink.Create.CommandLine" Version="2.7.0-b626" PrivateAssets="all" />
   </ItemGroup>
 </Project>