x/pkgsite: support symlinks or LICENSES directory #40586
Milestone
Comments
Please see this post to understand why we check licenses and godoc.org doesn't. For legal reasons, we cannot consider SPDX headers authoritative. We must verify the license text itself. A |
Please see [this
post](https://groups.google.com/g/golang-dev/c/mfiPCtJ1BGU/m/qtCrqlrEEwAJ)
to understand why we check licenses and godoc.org doesn't.
Thanks for the background and clarification.
For the record, the following link also works without having a Google
account.
https://groups.google.com/d/msg/golang-dev/mfiPCtJ1BGU/qtCrqlrEEwAJ
A `LICENSES` directory is a reasonable request. We'll look into it.
That would be very cool, thanks. Alternatively, could a license hint or
link to such a file also be included in the go.mod file, for example?
|
I don't think the go.mod file is the right place for that sort of information. We don't add information to go.mod that is obtainable elsewhere, or that is language-agnostic. |
This was referenced Nov 13, 2020
Any updates? After closing down the good old godoc.org and redirecting to the new pkg.go.dev thingy, there is no more documentation for properly licensed code. A promising alternative seems to be godocs.io. However, for my next release I will add a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
On a project I am working on, I recently implemented the Free Software Foundation Europe's REUSE (repository) recommendations for licensing. The used licenses are the GNU GPL for code and CC0 for some other stuff, both listed as supported licenses.
In a nutshell, REUSE stores all licenses named as their SPDX identifier in a
LICENSES
directory. Furthermore, each file starts with a SPDX header.Because GitHub does not handled this, I created a
LICENSE
symlink to the GPL file within theLICENSES
directory. GitHub then at least detects the presence of a license. (Edit: GitHub only detects aLICENSE
file exists, but does not follow the symlink. Thus, I removed the symlink.)However, the pkg.go.dev page is currently not able to process this. Furthermore, the documentation is "not displayed due to license restrictions". Compared to this, the old GoDoc has no limitations in this regard. Sorry, this is annoying.
Would it be possible to adjust pkg.go.dev to
LICENSES
directory,detect and follow symlinks, or(Edit: see edit above)Thanks a lot for all the great work!
The text was updated successfully, but these errors were encountered: