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: support symlinks or LICENSES directory #40586

Open
oxzi opened this issue Aug 5, 2020 · 3 comments
Open

x/pkgsite: support symlinks or LICENSES directory #40586

oxzi opened this issue Aug 5, 2020 · 3 comments

Comments

@oxzi
Copy link

@oxzi oxzi commented Aug 5, 2020

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 the LICENSES directory. GitHub then at least detects the presence of a license. (Edit: GitHub only detects a LICENSE 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

  • handle a LICENSES directory,
  • detect and follow symlinks, or (Edit: see edit above)
  • to parse SPDX headers?

Thanks a lot for all the great work!

@gopherbot gopherbot added this to the Unreleased milestone Aug 5, 2020
@julieqiu julieqiu added the pkgsite label Sep 14, 2020
@jba jba modified the milestones: Unreleased, pkgsite/licenses Sep 15, 2020
@jba
Copy link
Contributor

@jba jba commented Sep 15, 2020

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 LICENSES directory is a reasonable request. We'll look into it.

@oxzi
Copy link
Author

@oxzi oxzi commented Sep 16, 2020

@jba
Copy link
Contributor

@jba jba commented Sep 16, 2020

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.

@gopherbot gopherbot added the go.dev label Sep 18, 2020
@julieqiu julieqiu removed the go.dev label Sep 19, 2020
@gopherbot gopherbot added the go.dev label Sep 19, 2020
@julieqiu julieqiu removed the go.dev label Sep 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.