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

fix pkg.go.dev license detection #431

Closed
bnewbold opened this issue Nov 10, 2023 · 4 comments
Closed

fix pkg.go.dev license detection #431

bnewbold opened this issue Nov 10, 2023 · 4 comments

Comments

@bnewbold
Copy link
Collaborator

derp, pkg.go.dev doesn't know what to do with the MIT-or-Apache license, and as a result won't render docs.

eg: https://pkg.go.dev/github.com/bluesky-social/indigo/atproto/crypto

we can file a bug report, or try to re-format LICENSE.txt so it doesn't trigger this (eg, detect as MIT, which is fine for us), or potentially even move the "or apache" part to a separate PATENTS.txt file.

annoying!

@erka
Copy link
Contributor

erka commented Nov 13, 2023

Github isn't happy about LICENSE.txt too.
image

Probably try to reformat that file is the first option.

@bnewbold
Copy link
Collaborator Author

bnewbold commented Nov 21, 2023

I tried tweaking LICENSE.txt in #445 and that didn't fix it. As you mention Github is also confused but that doesn't really matter for the golang pkg website. Which is a great resource to host rendered docs!

A similar existing repo that does work is ipfs/kubo: https://pkg.go.dev/github.com/ipfs/kubo?tab=licenses

I tried downloading the licensecheck golang lib mentioned on pkg.go.dev and it gave higher confidence with the tweaked LICENSE.txt, which gave me hope that would fix it, but still get "License: UNKNOWN": https://pkg.go.dev/github.com/bluesky-social/indigo

I'm not sure if there is a specific confidence threshold or expected format or what.

@erka
Copy link
Contributor

erka commented Nov 22, 2023

ipfs/go-ds-badger4 and ipfs/boxo have similar licenses and it works great. But ipfs/gateway-conformance has the same files as ipfs/kubo and it has the same issue as indigo. It looks something wrong or some manual work was done.

@bnewbold
Copy link
Collaborator Author

Finally resolved this in f8ba20dc70977589322ff20abe52bfc49796b8bb after testing a few variations as separate repos.

h/t to @imax9000 in 956bf05 who traced it down to the LICENSE file name. renaming to LICENSE-DUAL made pkg.go.dev happy.

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

No branches or pull requests

2 participants