Debugging .NET Core external code from a private GitHub repo

rider-debugging-external-code-private-repo.md

HOWTO: Debug .NET Core external code from a 🔒 private GitHub repository, using JetBrains Rider

GITHUB: Create a GitHub "PAT" (Personal Access Token)

To access any locked/private resources in GitHub, you need a PAT. This is a specific access key that you can create to unlock whatever resource you own.

• Login to GitHub
• Click on your avatar icon (top right corner) -> Settings
• Now click Developer Settings -> Personal Access Tokens
• Click "Generate New Token" button
• Give it some name/description in the "Note" textbox. E.g. Rider External Sources PAT
• Decide on an expiration.
• Check/tick the repo scope
• Click "generate token" at the bottom of the page.
• WARNING: copy this secret password-PAT thingy. Once it disappears, you cannot see it again. (If that happens, then you will need to repeat the above PAT-steps, again).

RIDER: Enable external sources

• REF 1: https://www.jetbrains.com/help/rider/Debugging_External_Code.html
• REF 2: https://blog.jetbrains.com/dotnet/2018/03/06/credential-providers-private-nuget-feeds-rider-2018-1-eap/
• REF 3: https://youtrack.jetbrains.com/issue/RIDER-16260
• Make sure this setting is checked/ticked: Settings->Tools->External Symbols: "Enable private Source Link support"

CODE: Start debugging your code

• Add a breakpoint to some code which is located inside the external library.
• Run app
• Step into this method (from the external library)
• You should get an error -> 404 file cannot be found.
• In the same error message dialogue, click "Authenticate"
• Enter your GitHub credentials: GitHub username and PAT-password text (generated, just above)
• Retry and see if this works.