Skip to content
This repository has been archived by the owner on Oct 11, 2021. It is now read-only.

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

Open
flcdrg opened this issue Dec 25, 2019 · 2 comments

Comments

@flcdrg
Copy link
Member

flcdrg commented Dec 25, 2019

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:

  • Ignore any URLs that are inside code blocks
  • Ignore any URLs that are not within a MarkDown hyperlink
  • For any remaining URLs that are found to be invalid, just raise a warning (instead of a failing error) and display the actual URL in question (to help package maintainers figure out if there's a real problem they can fix or not)

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
Copy link
Member

gep13 commented Jan 6, 2020

This issue is related to this one:

#207

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

@gep13
Copy link
Member

gep13 commented Jan 6, 2020

@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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants