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: make LICENSE detection optional in pkgsite codebase (not in pkg.go.dev) #39602

Open
marwan-at-work opened this issue Jun 16, 2020 · 2 comments
Assignees
Labels
Milestone

Comments

@marwan-at-work
Copy link
Contributor

@marwan-at-work marwan-at-work commented Jun 16, 2020

Overview

Now that pkgsite is open sourced (congrats btw!), developers can run the server for sharing documentation of their private code amongst their internal teams.

However, private code almost always does not have a LICENSE file in its root repository because employees typically sign a separate agreement stating that the internal code is not to be copied or shared.

This means that pkgsite won't be able to show any documentation for most of the internal code out there (or at least the ones I've worked with as it is hard to quantify what you cannot access).

One option is to go around and add an appropriate LICENSE for all of the private code that both pkgsite can detect: https://pkg.go.dev/license-policy and is an appropriate LICENSE for private code. However, most of the licenses that pkgsite detects seem to be open-source oriented which is a non-starter for private modules. Even if there was a LICENSE that was meant for private-code, it doesn't guarantee that all teams can use it within their private repositories as it requires approvals from their company's legal entities.

Proposal

Therefore, it seems like the best option is to add a new configuration to pkgsite that bypasses the LICENSE check all together so that developers running the server for their internal teams don't need to go add a LICENSE to all of their private modules while still benefiting from using pkgsite and be able to give feedback!

Thanks!

@gopherbot gopherbot added this to the Unreleased milestone Jun 16, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Jun 16, 2020

/cc @jba

@julieqiu julieqiu changed the title go.dev: make LICENSE detection optional in pkgsite codebase (not in pkg.go.dev) x/pkgsite: make LICENSE detection optional in pkgsite codebase (not in pkg.go.dev) Jun 16, 2020
@MicahParks
Copy link

@MicahParks MicahParks commented Aug 1, 2020

This does not solve this issue, as it is not a pull request, but I have a project that will hard code license respecting off and run pkgsite as a docker container. It has a few other use cases too.

I could figure out how to solve this with a flag, then create & submit pull request, unless the Go team is already on the issue.

I was able to use sed commands in the Dockerfile I made to manipulate some booleans that allowed the docs to build for projects without permissive licenses. You can see the affected files/lines in any of the athens.Dockerfile files in the below projects.

GitLab project
GitHub mirror

@jba jba self-assigned this Aug 4, 2020
@jba jba removed the NeedsInvestigation label Aug 4, 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.