Skip to content

x/pkgsite: make LICENSE detection optional in pkgsite codebase (not in pkg.go.dev) #39602

@marwan-at-work

Description

@marwan-at-work

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    FrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.pkgsite

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions