Skip to content

Emit a file that lists which packages don't use ///-source-of-truth #120726

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −0
Open

Emit a file that lists which packages don't use ///-source-of-truth #120726

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcbe06b
Emit a file that lists which packages don't use ///-source-of-truth
ericstj Oct 14, 2025
883c208
Use ReferencePath to identify packages without compiler generated docs
ericstj Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions ...ntime.DotNetApiDocs.Transport/src/Microsoft.Internal.Runtime.DotNetApiDocs.Transport.proj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
<TfmSpecificPackageFile Include="@(ReferenceAssemblyFile);
@(CompilerGeneratedXmlDocFile)"
PackagePath="ref\$(NetCoreAppCurrent)\" />
<NoDocPackages Include="@(ProjectReferenceCopyLocalPathNonPrivate->WithoutMetadataValue('UseCompilerGeneratedDocXmlFile', 'true')->WithMetadataValue('IsPackable', 'true')->'%(PackageId)'->Distinct())" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the same as searching for projects that have UseCompilerGeneratedDocXmlFile explicitly set to false?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the combination of UseCompilerGeneratedDocXmlFile=false && IsPackable=true

</ItemGroup>

<ItemGroup>
Expand All @@ -46,6 +47,13 @@
<PlatformNotSupportedCompilerGeneratedXmlDocFile Remove="@(PlatformNotSupportedCompilerGeneratedXmlDocFile->WithMetadataValue('SuppressPlatformNotSupportedAssemblyDocXmlError', 'true'))" />
</ItemGroup>

<WriteLinesToFile Lines="@(NoDocPackages)"
File="$(OutputPath)NoDocPackages.txt"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In answer to @ViktorHofer question, I don't ingest packages via the transport package. Could I still read this file from the app that I run to generate the list of NuGet packages to ingest?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you use this package at all today?

You could PackageDownload the package, and then use Content to copy this file from the package.

Or I could change where I place the file in the package and make it automatically copied to the output directory of the app.

Today, this transport package includes all the assemblies under ref\net10.0 which would make them automatically be referenced when the package is referenced on net10.0. I doubt this is what you want, since you probably want to treat its contents as data.

So... tell us what works best for you and we'll make it happen.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or I could change where I place the file in the package and make it automatically copied to the output directory of the app.

That would be great if you can.

Overwrite="true" />
<ItemGroup>
<TfmSpecificPackageFile Include="$(OutputPath)NoDocPackages.txt" PackagePath="ref\$(NetCoreAppCurrent)\" />
</ItemGroup>

<Error Text="Compiler generated XML documentation files are missing data because partial facade assemblies aren't supported by the repo infrastructure. Consider removing the partial facade feature. Assemblies: @(PartialFacadeCompilerGeneratedXmlDocFile->Metadata('Filename'), ', ')."
Condition="'@(PartialFacadeCompilerGeneratedXmlDocFile)' != ''" />

Expand Down
Loading