Skip NuGet package XML doc extraction by default #212
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR changes the NuGet package restore behavior to skip extracting XML documentation files by default. These files are typically not needed for non-interactive/CI build scenarios, but can add substantially to the NuGet cache layer size.
As an example, publishing the .NET Getting Started app (on an M1 Mac) adds ~813MB to the NuGet cache when XML docs are extracted (default), compared to ~570MB when skipped.
The environment variable is set as a default, respecting build-time environment configuration. Users may set
NUGET_XMLDOC_MODE
tonone
,compress
, orskip
as documented here.This default should be documented in this Dev Center article when released.