chocolatey / package-validator

Windows service to validate packages conform to package standards
Apache License 2.0
31 stars 29 forks source link

URL validation within Description and ReleaseNotes is breaking on example URLs #197

Open flcdrg opened 4 years ago

flcdrg commented 4 years ago

The new URL validation is a little too strict for description and releaseNotes fields.

For example, https://chocolatey.org/packages/azure-pipelines-agent/2.163.1 now fails, presumably because 'example' URLs are used in the description.

I'd recommend that for description and releaseNotes, adopt the following approach:

For releaseNotes, while this element can contain any text, some packages do just put a single URL as the content. In that specific case, I think it would be reasonable to apply the strict failing validation to the URL, but for all other content in releaseNotes then apply the same rules above as for description

gep13 commented 4 years ago

This issue is related to this one:

https://github.com/chocolatey/package-validator/issues/207

Switching Description and Release Notes to guidelines is in line with what this issue was created for.

gep13 commented 4 years ago

@flcdrg I think that there is still work to be done on this issue to account for everything, but the package that you specifically mention in the issue has now successfully passed validation.