dspace-group/dscom

Enhancement: Usage of .NET SourceLink

Closed this issue · 0 comments

Using .NET Sourcelink, nuget packages can be published that will reference not only the project on github, but also the commit that was used for the creation of the package.

For details, please refer to the package and the repository.

It is really easy to introduce: Just add the package Microsoft.SourceLink.Github to the development dependencies of the project to be published.

According to the project website, the following new properties should be added to the project:

    <!-- Optional: Publish the repository URL in the built .nupkg (in the NuSpec <Repository> element) -->
    <PublishRepositoryUrl>true</PublishRepositoryUrl>
 
    <!-- Optional: Embed source files that are not tracked by the source control manager in the PDB -->
    <EmbedUntrackedSources>true</EmbedUntrackedSources>
  
    <!-- Optional: Build symbol package (.snupkg) to distribute the PDB containing Source Link -->
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>

The first one should already be setup for dscom.
The second parameter will include generated code to the pdb. This is optional.
The third and fourth parameter can be used to create a symbol nuget package (snupkg), which will remove the necessity to use a symbol server.