Enabling source code debugging for your NuGet packages with GitLink
Recently on Twitter, someone was complaining that their CI builds were failing due to SymbolSource.org either being down or rejecting their packages. Fortunately, there's a better way than using SymbolSource if you're using a public Git repo (like GitHub) to host your project -- GitLink.
Symbols, SymbolSource and NuGet
Hopefully by now, most of you know that you need to create symbols (PDB's) for your release libraries in addition to your debug builds. Having symbols helps your users troubleshoot issues that may crop up when they're using your library. Without symbols, you need to rely on hacks, like using dotPeek as a Symbol Server. It's a hack because the generated source code usually doesn't match the original, and it certainly doesn't include any helpful comments (you do comment your code, right?)
So you've updated your project build properties to create symbols for release, now you need someplace to put them so your users can get them. Up until recently, the easiest way has been to publish them on SymbolSource. You'd include the pdb files in your NuGet NuSpec, and then run
nuget pack MyLibrary.nuspec -symbols. NuGet then creates two packages, one with your library and one just with the symbols. If you then run
nuget push MyLibrary.1.0.0.nupkg, if there's also a symbols package alongside, NuGet will push that to SymbolSource instead of NuGet.org. If you're lucky, things will just work. However, sometimes SymbolSource doesn't like your PDB's and your push will fail.
While SymbolSource is a great tool, there are some shortcomings.
* It requires manual configuration by the library consumer
* They have to know to go to VS and add the SymbolSource URL to the symbol search path
* It slows down your debugging experience. VS will by default check every configured Symbol Server for matching PDB's. That leads many people to either disable symbol loading entirely or selectively load symbols. Even if you selectively load symbols, the load is still slow as VS has know way to know which Symbol Server a PDB might be on and must check all of them.
* Doesn't enable Source Code debugging. PDB's can be indexed to map original source code file metadata into them (the file location, not contents). If you've source-indexed your PDB's and the user has source server support enabled, VS will automatically download the matching source code. This is great for OSS projects with their code on GitHub.
GitLink to the Rescue
GitLink provides us an elegant solution. When GitLink is run after your build step, it detects the current commit (assuming the sln is in a git repo clone), detects the provider (BitBucket and GitHub are currently supported) and indexes the PDB's to point to the exact source location online. Of course, there are options to specify commits, remote repo location URLs, etc if you need to override the defaults.
After running GitLink, just include the PDB files in your nuspec/main nupkg alongside your dll files and you're done. Upload that whole package to NuGet (and don't use the
-symbols parameter with
nuget pack). This also means that users don't need to configure a symbol server as the source-indexed PDB's will be alongside the dll -- the location VS will auto-load them from.
Over at xUnit and xUnit for Devices, we've implemented GitLink as part of our builds. xUnit builds are setup to run msbuild on an "outer" .msbuild project with high-level tasks; we have a GitLink task that runs after our main build task.
As we want the build to be fully automated and not rely on exe's external to the project, we "install" the GitLink NuGet package on build if necessary.
Here's the gist of our main CI target that we call on build
msbuild xunit.msbuild /t:CI (abbreviated for clarity):
<PropertyGroup> <SolutionName Condition="'$(SolutionName)' == ''">xunit.vs2015.sln</SolutionName> <SolutionDir Condition="'$(SolutionDir)' == '' Or '$(SolutionDir)' == '*Undefined*'">$(MSBuildProjectDirectory)</SolutionDir> <NuGetExePath Condition="'$(NuGetExePath)' == ''">$(SolutionDir)\.nuget\nuget.exe</NuGetExePath> </PropertyGroup> <Target Name="CI" DependsOnTargets="Clean;PackageRestore;GitLink;Build;Packages" /> <Target Name="PackageRestore" DependsOnTargets="_DownloadNuGet"> <Message Text="Restoring NuGet packages..." Importance="High" /> <Exec Command=""$(NuGetExePath)" install gitlink -SolutionDir "$(SolutionDir)" -Verbosity quiet -ExcludeVersion -pre" Condition="!Exists('$(SolutionDir)\packages\gitlink\')" /> <Exec Command=""$(NuGetExePath)" restore "$(SolutionDir)\$(SolutionName)" -NonInteractive -Source @(PackageSource) -Verbosity quiet" /> </Target> <Target Name='GitLink'> <Exec Command='packages\gitlink\lib\net45\GitLink.exe $(MSBuildThisFileDirectory) -f $(SolutionName) -u https://github.com/xunit/xunit' IgnoreExitCode='true' /> </Target> <Target Name='Packages'> <Exec Command='"$(NuGetExePath)" pack %(NuspecFiles.Identity) -NoPackageAnalysis -NonInteractive -Verbosity quiet' /> </Target>
There are a few things to note from the snippet:
* When installing GitLink, I use the
-ExcludeVersion switch. This is so it's easier to call later in the script w/o remembering to update a target path each time.
* I'm currently using
-pre as well. There's a number of bugs fixed since the last stable release.
The end result
If you use xUnit 2.0+ or xUnit for Devices and have source server support enabled in your VS debug settings, VS will let you step into xUnit code seamlessly.
If you do this for your library, your users will thank you.