Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Source Link support #968

Closed
2 tasks
qidydl opened this issue Nov 11, 2021 · 4 comments
Closed
2 tasks

Add Source Link support #968

qidydl opened this issue Nov 11, 2021 · 4 comments
Labels
feature-request A feature should be added or improved. module/lambda-client-lib p2 This is a standard priority issue queued

Comments

@qidydl
Copy link

qidydl commented Nov 11, 2021

Adding support for Source Link would improve the debugging experience for the AWS .NET libraries and make it easier to trace back to source code to investigate issues.

Describe the Feature

Source Link embeds information in a NuGet package that identifies the repository and commit that was used to build the package, so that developer tools (e.g. Visual Studio) can download the source when debugging, so that developers can then step through it, set breakpoints, etc. It also establishes a traceability link.

Is your Feature Request related to a problem?

I'm having some difficulty with logging, and it would be easier to investigate if I could know exactly what the Amazon.Lambda.AspNetCoreServer library is doing when it's running.

Proposed Solution

There are a few project properties to set (maybe in the shared buildtools\common.props?) and a package to reference that automatically supports GitHub. That would affect a lot of projects so maybe it is tested on just one or a few first. It would take effect with the next release.

Describe alternatives you've considered

I'm not sure if there are any alternatives to Source Link that achieve the same thing. Source Link seems to be a standard at least within the .NET/NuGet community.

Additional Context

I'm trying to understand the run-time behavior of libraries like Amazon.Lambda.AspNetCoreServer in detail so I can use them correctly. More documentation and examples can help, but are unlikely to always cover every corner case.

Environment

This should not be specific to any environment, although not all tools may take advantage of the Source Link metadata.

  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request

@qidydl qidydl added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Nov 11, 2021
@ashishdhingra
Copy link
Contributor

Needs review with the team.

@jon-armen
Copy link
Contributor

@ashishdhingra - I have submitted #1089 for this issue. @qidydl , do you believe this would resolve?

@ashishdhingra ashishdhingra added the p3 This is a minor priority issue label Dec 21, 2022
@ashishdhingra ashishdhingra added p2 This is a standard priority issue queued and removed p3 This is a minor priority issue needs-review labels Mar 24, 2023
@ashishdhingra
Copy link
Contributor

Resolving because this is done by default with .NET 8.

@ashishdhingra ashishdhingra closed this as not planned Won't fix, can't repro, duplicate, stale Aug 5, 2024
Copy link
Contributor

github-actions bot commented Aug 5, 2024

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. module/lambda-client-lib p2 This is a standard priority issue queued
Projects
None yet
Development

No branches or pull requests

3 participants