Skip to content
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.

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

Epic: Improve package validation #8875

Open
rrelyea opened this issue Dec 4, 2019 · 2 comments
Open

Epic: Improve package validation #8875

rrelyea opened this issue Dec 4, 2019 · 2 comments
Labels
Area:PackageDefinition Category:Quality Week Issues that should be considered for quality week Functionality:Pack Priority:2 Issues for the current backlog. Type:DCR Design Change Request

Comments

@rrelyea
Copy link
Contributor

rrelyea commented Dec 4, 2019

dotnet/extensions#2744 details a break that occurred when dotnet core 3.1.0 shipped yesterday. Some packages had added embedded icons...but had two entries.

This item covers a new validation rule - "catch the duplicate zip item' problem. (note, pay attention to encoding too... "foo bar" and "foo%20bar" as item names get extracted to the same file. How should we treat that?

It also needs several places to run... sketch of plan is below:

They use some components of the dotnet pack codepath, but avoided a validation that our pack code already does.

As part of our PackageQuality epic that is coming up soon on our backlog, we have plans to:

  • have a set of concrete guidelines for package quality.
  • increase validations at dotnet pack time
  • add a new entry point to CLI to allow people who custom pack packages to get most of our validation rules run - nuget verify -all foo.nupkg
  • do more validations on the server when nuget.org gets packages submitted
  • nuget.org and vs package manager UI would show a grade (or similar) to show how great (or not) a package is.
@rrelyea rrelyea added this to the Backlog milestone Dec 4, 2019
@nkolev92 nkolev92 removed this from the Backlog milestone Feb 11, 2020
@nkolev92 nkolev92 added Priority:2 Issues for the current backlog. Category:Quality Week Issues that should be considered for quality week labels Feb 11, 2020
@aortiz-msft aortiz-msft changed the title NuGet verify -all should add validation to catch duplicate files in nupkg Add a NuGet verify -all command Mar 17, 2020
@aortiz-msft aortiz-msft changed the title Add a NuGet verify -all command Epic: Improve package validation Mar 17, 2020
@Pilchie
Copy link

Pilchie commented Mar 17, 2020

ASP.NET had previously built a validation system as well. It implemented a set of rules you can see here.

Some of these are .NET Core specific, some are Microsoft specific, but there have been a bunch of issues here.

Additionally, with package reservation and signing requirements, it would be extremely valuable to have a server that we can push to that validates everything that nuget.org does at publish time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area:PackageDefinition Category:Quality Week Issues that should be considered for quality week Functionality:Pack Priority:2 Issues for the current backlog. Type:DCR Design Change Request
Projects
None yet
Development

No branches or pull requests

5 participants