zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-05 23:06:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f9fb116eabe0028b7e61d25bbe81403673338824
octokit.net/docs/debugging-source.md
Nick Floyd 00b89daa23 [maint] Removes the old implementation of sourcelink and uses the newer one present in the .net SDK (#2666) 
* reoves the old implemetnation of sourcelink and uses the newer one  present in the .net SDK

* cleans up appveyor

* updates proj with sourcelink props

* adds deterministic build check as well.

* Update docs/debugging-source.md

Co-authored-by: Keegan Campbell <me@kfcampbell.com>

---------

Co-authored-by: Keegan Campbell <me@kfcampbell.com>
2023-02-07 11:14:49 -06:00

1.3 KiB
Raw Blame History

Debugging Octokit Source in your app

As of version 0.6, Octokit supports symbol debugging - this enables you to step into the Octokit source without having the repository on your local machine.

Enable Symbol Debugging

To enable this, you need to enable this in VS:

  • From the top Tools menu, select Options
  • Select Debugging from the left sidebar and expand General

Ensure you have checked Enable source server support:

Enable source server support

How does this actually work?

When you hit a breakpoint in your application, you can step into the Octokit source code using F11. This will retrieve the source file associated with a specific type, and cache it in your local symbols cache.

F11 step into symbol

You can then set subsequent breakpoints inside the source code, to return to in the debugging session.

Acknowledgements

Thanks to Cameron Taggart for the initial implementation and the .NET foundation for ongoing support of SourceLink which we use to provide source debugging.