diff --git a/README.md b/README.md index c0ffb36..5e81364 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The [source link documention](https://github.com/dotnet/core/blob/master/Documen ``` xml - + ``` @@ -67,7 +67,7 @@ msbuild /t:rebuild /p:ci=true /v:n Install by adding: ``` xml - + ``` ## examples @@ -76,7 +76,7 @@ Install by adding: `dotnet sourcelink test` may also be run by using the `SourceLink.Test` MSBuild targets. ``` xml - + ``` 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 - - + + ``` # 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 - + ``` ## 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 - + ``` # 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);.pdb - ``` - - 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 - - $(TargetsForTfmSpecificContentInPackage);IncludePDBsInPackage - - - - - - - ``` + 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). \ No newline at end of file diff --git a/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.csproj b/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.csproj index 36fd61d..1b10f0f 100644 --- a/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.csproj +++ b/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.csproj @@ -14,6 +14,14 @@ + + true + build + + + true + buildCrossTargeting + true build diff --git a/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.props b/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Create.BitBucket/SourceLink.Create.BitBucket.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.csproj b/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.csproj index 97481b8..78414fe 100644 --- a/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.csproj +++ b/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.csproj @@ -14,6 +14,14 @@ + + true + build + + + true + buildCrossTargeting + true build diff --git a/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.props b/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Create.BitBucketServer/SourceLink.Create.BitBucketServer.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.csproj b/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.csproj index 03038d6..dab0df9 100644 --- a/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.csproj +++ b/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.csproj @@ -22,6 +22,14 @@ + + true + build + + + true + buildCrossTargeting + true build @@ -44,7 +52,7 @@ - - + + \ No newline at end of file diff --git a/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.props b/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Create.CommandLine/SourceLink.Create.CommandLine.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj index 3e73991..e865560 100644 --- a/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj +++ b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj @@ -14,6 +14,14 @@ + + true + build + + + true + buildCrossTargeting + true build diff --git a/SourceLink.Create.GitHub/SourceLink.Create.GitHub.props b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/SourceLink.Create.GitLab/SourceLink.Create.GitLab.csproj b/SourceLink.Create.GitLab/SourceLink.Create.GitLab.csproj index 6655fc1..1a1f842 100644 --- a/SourceLink.Create.GitLab/SourceLink.Create.GitLab.csproj +++ b/SourceLink.Create.GitLab/SourceLink.Create.GitLab.csproj @@ -14,6 +14,14 @@ + + true + build + + + true + buildCrossTargeting + true build diff --git a/SourceLink.Create.GitLab/SourceLink.Create.GitLab.props b/SourceLink.Create.GitLab/SourceLink.Create.GitLab.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Create.GitLab/SourceLink.Create.GitLab.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.csproj b/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.csproj index 5c34adf..1d9c801 100644 --- a/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.csproj +++ b/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.csproj @@ -6,6 +6,14 @@ + + true + build + + + true + buildCrossTargeting + true build diff --git a/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.props b/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Embed.AllSourceFiles/SourceLink.Embed.AllSourceFiles.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.csproj b/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.csproj index 6272ec8..09b648a 100644 --- a/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.csproj +++ b/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.csproj @@ -6,6 +6,14 @@ + + true + build + + + true + buildCrossTargeting + true build diff --git a/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.props b/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.props new file mode 100644 index 0000000..b3658d6 --- /dev/null +++ b/SourceLink.Embed.PaketFiles/SourceLink.Embed.PaketFiles.props @@ -0,0 +1,5 @@ + + + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + \ No newline at end of file diff --git a/build/build.proj b/build/build.proj index f44516e..6f80a2f 100644 --- a/build/build.proj +++ b/build/build.proj @@ -4,6 +4,6 @@ - + \ No newline at end of file diff --git a/build/sourcelink.props b/build/sourcelink.props index aac1f99..663f9b9 100644 --- a/build/sourcelink.props +++ b/build/sourcelink.props @@ -1,5 +1,5 @@ - + \ No newline at end of file