search

dotnet / maintenance-packages

Repository that hosts packages from the .NET platform whose original home/branch is not building any longer.
MIT License
22 stars 10 forks source link

Building the repo clean creates edits to intellisense xml files #139

Closed ericstj closed 3 weeks ago

ericstj commented 1 month ago

I'm not sure why we have the DocumentationFile property set up as a checked in file: https://github.com/dotnet/maintenance-packages/blob/f2efa3ea224239fa79ef7953180804830c4a146e/src/Microsoft.IO.Redist/src/Microsoft.IO.Redist.csproj#L12

This will make the compiler write to the source directory on build. Related #133

ViktorHofer commented 1 month ago

This is still an issue:

Image

carlossanlop commented 4 weeks ago

Adding xml files to the repo was the quickest way to ensure that all the assemblies had a documentation file in their nupkgs. It's not the ideal way but it works. They were the same xmls that were included in the last released nupkgs from nuget.org.

The correct fix is to ensure that no xml is checked-in and the docs are generated out of triple slash. I might have to backport docs from MS Learn to ensure we have the latest docs.

There were two assemblies that in their migrated source code included their xmls though: Redist and Unsafe. I'll have to investigate if we will need to continue consuming their provided xml or not.