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

Include documentation and source link in the .NET core and standard packages #222

Open
megla-tlanghorst opened this issue Jan 8, 2025 · 1 comment

Comments

@megla-tlanghorst
Copy link

The .NET (Core) and .NET Standard packages do not include the XML comments file:
image

The .NET Framework Package does include it:
image

The required source code commit for source link is also missing in the metadata of all packages, so source link is unavailable:
image

It should look like this:
image

Instruction on how to set it up can be found here: https://github.com/dotnet/sourcelink/blob/main/README.md

Lastly maybe if you want to save some hassle for both yourself and your users you could also consolidate net462, netstandard1.3 and .netcoreapp3.1 (plus maybe nowadays net8.0?) into a single package like CFX.CFXSDK and MSBuild will then choose the best, compatible version automatically without any need to manually wind the right package. That looks like this then:
image

@megla-tlanghorst
Copy link
Author

megla-tlanghorst commented Jan 8, 2025

As I understand it if you build it using .NET 8 (doesn't necessarily have be the or the only target though I think) some of this may be solved automatically at least regarding sourcelink.

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

No branches or pull requests

1 participant