Update PublishRepositoryUrl in README by MattKotsenas · Pull Request #1270 · dotnet/sourcelink (original) (raw)
@tmat, I thought about this more and I think I came up with a better framing. I made a small addition to the opening section to capture that what we (I?) think of as "Source Link" is three components:
- Embedding source information into the PDB
- Adding source information into the .nuspec
- Distributing PDBs
1 and 2 coupled in the current version of the docs, which is what lead to confusion in the linked bug. Currently, the docs make it look to some readers that in .NET 8+, 1 and 2 happen automatically, but only 1 happens automatically. The previous version of this PR made it sound like 1 and 2 are both controlled by <PublishRepositoryUrl>, which isn't true either.
Now I think it's clearer that:
- 1 is controlled by including the package (or using a new SDK)
- I also moved the
<EmbedUntrackedSources>suggestion to this part as well, since it's coupled to the SDK decision and independent of the NuGet part
- I also moved the
- .nuspec information is controlled by
<PublishRepositoryUrl>
@tmat let me know what you think. Very happy to hear and include your feedback. Thanks!