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

x/pkgsite: license file issue with only-for-human LICENSE.md file #49155

Closed
kortschak opened this issue Oct 25, 2021 · 4 comments
Closed

x/pkgsite: license file issue with only-for-human LICENSE.md file #49155

kortschak opened this issue Oct 25, 2021 · 4 comments
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite

Comments

@kortschak
Copy link
Contributor

What is the URL of the page with the issue?

https://pkg.go.dev/gonum.org/v1/gonum@v0.9.1-0.20210927225948-aad206551871/graph/formats/rdf

What is your user agent?

Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:93.0) Gecko/20100101 Firefox/93.0

What did you do?

Navigate to the url above.

What did you expect to see?

Documentation.

What did you see instead?

License warning.

I imagine that this is due to the LICENSE.md file in that directory which is not intended for machine interpretation and does not cover any text that would be rendered by pkg.go.dev.

Because of the exhaustive license name matching[1] it is unclear how to name this file so that it 1. is understandable to a human and 2. not incorrectly read by licensecheck.

[1]

COPYING, COPYING.md, COPYING.markdown, COPYING.txt, LICENCE, LICENCE.md, LICENCE.markdown, LICENCE.txt, LICENSE, LICENSE.md, LICENSE.markdown, LICENSE.txt, LICENSE-2.0.txt, LICENCE-2.0.txt, LICENSE-APACHE, LICENCE-APACHE, LICENSE-APACHE-2.0.txt, LICENCE-APACHE-2.0.txt, LICENSE-MIT, LICENCE-MIT, LICENSE.MIT, LICENCE.MIT, LICENSE.code, LICENCE.code, LICENSE.docs, LICENCE.docs, LICENSE.rst, LICENCE.rst, MIT-LICENSE, MIT-LICENCE, MIT-LICENSE.md, MIT-LICENCE.md, MIT-LICENSE.markdown, MIT-LICENCE.markdown, MIT-LICENSE.txt, MIT-LICENCE.txt, MIT_LICENSE, MIT_LICENCE, UNLICENSE, UNLICENCE. The match is case-insensitive.

@gopherbot gopherbot added this to the Unreleased milestone Oct 25, 2021
@jamalc jamalc added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Dec 10, 2021
@jamalc jamalc modified the milestones: Unreleased, pkgsite/unplanned Dec 10, 2021
@seankhliao
Copy link
Member

isn't the solution to just move the file into testdata/?

@kortschak
Copy link
Contributor Author

That is what we ended up doing, and in our case that was reasonable. In the general case though having a technology force an action like this isn't really appropriate. Because of the limitations of the license recognition algorithms (certainly improved since the original version) this kind of advice has been made in the past, to the extent of (paraphrasing), "your valid BSD-3 license isn't recognised by the code, the best thing to do would be to change it". This kind of thing doesn't seem reasonable.

@seankhliao
Copy link
Member

I think like #46291 (comment) , without human review, it's not unreasonable to for pkgsite both be conservative in applying license restrictions (ANDing everything, like in this case) as well as asking for standardization in machine recognizable formats.

I'd like the close this as there doesn't appear to be anymore actionable items for now.

@seankhliao seankhliao closed this as not planned Won't fix, can't repro, duplicate, stale May 5, 2023
@kortschak
Copy link
Contributor Author

The story around the approach to license handling has been very poor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite
Projects
None yet
Development

No branches or pull requests

4 participants