Enable Source Link for better debugging experience #140
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enables Source Link support for the LightProto library to improve the debugging experience when consuming the package from NuGet. The changes configure MSBuild properties for deterministic builds, symbol package generation, and add the Microsoft.SourceLink.GitHub package reference.
- Adds MSBuild properties to enable deterministic builds and symbol generation
- Integrates Microsoft.SourceLink.GitHub for source code debugging support
- Configures symbol package format as snupkg for NuGet compatibility
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <!-- Enable Source Link for better debugging experience --> | ||
| <PropertyGroup> | ||
| <Deterministic>true</Deterministic> | ||
| <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild> |
There was a problem hiding this comment.
Setting ContinuousIntegrationBuild to true unconditionally will break local development builds. This property should only be set to true in CI environments. When enabled for local builds, it causes Source Link to embed absolute file paths that won't exist on developers' machines, making debugging problematic.
The recommended approach is to use a condition that checks if the build is running in a CI environment. You can either:
- Remove this line and let the CI workflow set it via command line argument (e.g., dotnet pack -p:ContinuousIntegrationBuild=true)
- Use a condition like: Condition="'$(CI)' == 'true' OR '$(GITHUB_ACTIONS)' == 'true'"
Most CI systems automatically set environment variables that can be detected. GitHub Actions sets GITHUB_ACTIONS=true.
Suggested change
| <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild> | |
| <ContinuousIntegrationBuild Condition="'$(CI)' == 'true' OR '$(GITHUB_ACTIONS)' == 'true'">true</ContinuousIntegrationBuild> |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #140 +/- ##
=======================================
Coverage 98.39% 98.39%
=======================================
Files 99 99
Lines 2186 2186
Branches 231 231
=======================================
Hits 2151 2151
Misses 23 23
Partials 12 12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request improves the debugging experience for the
LightProtoproject by enabling Source Link and configuring symbol package generation. These changes will make it easier to debug into the source code when using the library from NuGet.Build and debugging improvements:
snupkg) in the project file (LightProto.csproj).Microsoft.SourceLink.GitHubto support Source Link integration for better debugging with source code.