NuGet/Home

Be smarter about PackagePath and Pack metadata values

Closed

#10,830 opened on May 5, 2021

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)HTML (292 forks)batch import
Functionality:PackIcebox cleanup candidatePriority:3Status:InactiveType:DCRhelp wanted

Repository metrics

Stars
 (1,459 stars)
PR merge metrics
 (Avg merge 464d 23h) (1 merged PR in 30d)

Description

See the documentation on adding package readme support, it states you need to add:

<PropertyGroup>
    ...
    <PackageReadmeFile>readme.md</PackageReadmeFile>
    ...
</PropertyGroup>

<ItemGroup>
    ...
    <None Include="docs\readme.md" Pack="true" PackagePath="\"/>
    ...
</ItemGroup>

Now, the PackagePath metadata is a packing-specific metadata item that is not used anywhere else (AFAIK). It seems quite obvious that if I specify a PackagePath metadata, it's because I want the item packed. Specifying also Pack=true seems entirely unnecessary and redundant.

So, the proposal is:

Whenever PackagePath is specified in any item (of the supported candidates), asume Pack=true for the item.

(this is what nugetizer does too, btw, it's more natural and less surprises).

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.