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

Unusual location for license defeats wwhrd and other tools #37

Closed
ijc opened this issue Apr 26, 2018 · 3 comments
Closed

Unusual location for license defeats wwhrd and other tools #37

ijc opened this issue Apr 26, 2018 · 3 comments

Comments

@ijc
Copy link
Contributor

ijc commented Apr 26, 2018

The Apache license for this project is in LICENSE.code, which means that wwhrd (and I suppose any other tool using go-license) cannot find it and so reports an unknown license (which is a failure). I've added an exception to my project but thought it worth raising since I don't like exceptions.

How would we feel about renaming LICENSE.code to just LICENSE (and leaving LICENSE.docs alone of course)? My argument for giving the code the "privileged" position is that automated tooling is going to primarily be interested in code (e.g. vendoring) while docs are not typically vendored or subject to automatic inclusion in quite the same way. Even more LICENSE.docs specifically only covers README.md and CONTRIBUTING.md which really aren't going to be vendored I think.

I can make the PR if we think this is a good idea.

As an alternative a symlink LICENSELICENSE.code would work too (I guess, I've not actually tried it)

There is an issue on go-license at ryanuber/go-license#16 but its from 2015 so I figured I would start here first.

@vbatts
Copy link
Member

vbatts commented Apr 26, 2018 via email

@dmcgowan
Copy link
Member

Not sure why some of these projects even have a license.docs file, perhaps inherited from the Docker registry. There are no docs but if just renaming License.code works then SGTM

@wking
Copy link
Contributor

wking commented Apr 26, 2018

Not sure why some of these projects even have a license.docs file…

I'd added LICENSE.docs in #12 to catch up with a README reference which landed in 36db198. If the Git history hasn't been truncated, @stevvooe and I are the only README authors. I'm happy reclicensing my contributions there under Apache-2.0 if that helps with the licensing (my README contributions may be too minimal to be copyrightable anyway).

CONTRIBUTING.md, on the other hand, is straight from docker/opensource (as described in 79405cf, #7), so if you want it relicensed under the Apache-2.0, you'll need to check there to see who owns the copyright. Alternatively, you could probably source an Apache-2.0 CONTRIBUTING.md directly from somewhere else (e.g. here) or write your own.

Just renaming LICENSE.code sounds simple enough and allows us to punt on getting an Apache-2.0 CONTRIBUTING.md.

ijc added a commit to ijc/go-digest that referenced this issue Apr 30, 2018
This allows automated tooling (such as license compatibilty checkers) to find
it.

Fixes opencontainers#37.

Signed-off-by: Ian Campbell <ijc@docker.com>
TBBle added a commit to TBBle/compose-on-kubernetes that referenced this issue Dec 19, 2020
This is a misdetection, since fixed upstream in go-digest.

See opencontainers/go-digest#37

Signed-off-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>
TBBle added a commit to TBBle/compose-on-kubernetes that referenced this issue Dec 19, 2020
This is a misdetection, since fixed upstream in go-digest.

See opencontainers/go-digest#37

Signed-off-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>
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

4 participants