How to debug into my nuget package deployed from TeamCity?

by

Traditional method

  1. Put the pdb in the NuGet package alongside the dll.
  2. Add the source code to the Debug Source Files for the solution that references the package.

This means you’ll be able to step through code and view exceptions, but you might have to find a file on disk and open it before you can set a breakpoint. Obviously you need to be careful that the source is at the right revision.

More detail on step

If you’re currently packaging without a Nuspec, you’ll need to create a Nuspec, then add the pdb to the list of files in the lib folder “NuGet spec” may be a useful command for generating the initial spec as defined in NuGet docs. Then ensure the Team City Nuget Pack step is referencing your new nuspec.

More detail on step 2

When you have a solution open, right click on Solution, select Properties…Common Properties…Debug Source Files, and add the root source directory for the relevant binary reference. Or see MSDN.
Note, you can’t open the solution properties while debugging.

Still not hitting breakpoints?

Try disabling this from Tools->Options:
Disable exact source match

Modern way for public or private repos

To ensure the exact version of the source is available, embed it at build time.

From Visual Studio 2017 15.5+ you can add the EmbedAllSources property:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <EmbedAllSources>true</EmbedAllSources>

Modern way for public repos

To keep your nuget and library size small, you can use the sourcelink package.

It generates a pdb that directs the debugger to the correct version of the file from your VCS provider (e.g. GitHub, BitBucket).

More Related Contents:

  1. System.MissingMethodException: Method not found?
  2. How do I get .NET Core projects to copy NuGet references to the build output?
  3. How do I enable NuGet Package Restore in Visual Studio?
  4. NuGet behind a proxy
  5. Install a .NET windows service without InstallUtil.exe
  6. How to deploy application with sql server database on clients
  7. Could not load file or assembly System.Runtime.CompilerServices.Unsafe
  8. Selenium Error – The HTTP request to the remote WebDriver timed out after 60 seconds
  9. Best way to deploy Visual Studio application that can run without installing
  10. Automatic native and managed DLLs extracting from Nuget Package
  11. Determine assembly version during a post-build event
  12. How to download a Nuget package without nuget.exe or Visual Studio extension?
  13. ILMerge Best Practices
  14. Add a package with a local package file in ‘dotnet’
  15. How do I find the fully qualified name of an assembly?
  16. Newtonsoft.json assembly package version mismatch
  17. How can I deploy a .NET application that uses ODAC without installing the whole component to the user?
  18. View NuGet package dependency hierarchy
  19. NuGet Package Manager: ‘AutoMapper’ already has a dependency defined for ‘Microsoft.CSharp’
  20. How can I include line numbers in a stack trace without a pdb?
  21. System.IO.FileNotFoundException: Could not load file or assembly ‘X’ or one of its dependencies when deploying the application
  22. Include ONLY .xml file of SPECIFIC nuget package in a different folder
  23. Unable to find the requested .Net Framework Data Provider – SQLite
  24. Installing a .NetStandard 2.0 Nuget package into a VS2015 Net 4.6.1 project
  25. How to display ClickOnce Version number on Windows Forms
  26. NUnit expected exceptions
  27. How do I deploy two ClickOnce versions simultaneously?
  28. Merge msi and exe
  29. Can not install NuGet package
  30. Found conflicts between System.Net.Http

Leave a Comment