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

Better Source Link Support #278

Closed
4 tasks done
milkshakeuk opened this issue Feb 19, 2022 · 1 comment
Closed
4 tasks done

Better Source Link Support #278

milkshakeuk opened this issue Feb 19, 2022 · 1 comment

Comments

@milkshakeuk
Copy link
Member

milkshakeuk commented Feb 19, 2022

Is your feature request related to a problem? Please describe.
Source Link is a technology that enables source code debugging of .NET assemblies from NuGet by developers. Source Link executes when creating the NuGet package and embeds source control metadata inside assemblies and the package. Developers who download the package and have Source Link enabled in Visual Studio can step into its source code. Source Link provides source control metadata to create a great debugging experience.

Describe the solution you'd like
This project already uses source link but is not using it to its potential.

  • ✔️ CONSIDER using Source Link to add source control metadata to your assemblies and NuGet packages.

  • ✔️ CONSIDER publishing symbol files (*.pdb).

For the best debugging experience your library should publish symbol files as well as use Source Link. For more information about symbol files and symbol packages, see Symbol packages.

  • ✔️ CONSIDER enabling deterministic builds.

Deterministic builds enable verification that the resulting binary was built from the specified source and provide traceability. For more information about deterministic builds and instructions for enabling them, see Deterministic Builds.

  • ✔️ Use metapackage for the main convenience NuGet package

Essentially a lightweight replacement which means it does not need to contain any Dlls, it just describes its dependencies instead which already exist as NuGet packages.

Describe alternatives you've considered
Do nothing, and debugging a project which uses nHapi will not have as pleasant an experience as it could.

Additional context
n/a

@milkshakeuk
Copy link
Member Author

Okay this is now complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant