mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
00b89daa23
* 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>
31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
# 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**:
|
|
|
|
|
|
|
|
### 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.
|
|
|
|
|
|
|
|
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](https://github.com/dotnet/sourcelink) which we use to provide source debugging.
|