-
Notifications
You must be signed in to change notification settings - Fork 62
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
Comments
that seems like a fine idea
…On 04/26/2018 11:37 AM, Ian Campbell wrote:
The Apache license for this project is in |LICENSE.code|, which means
that wwhrd <https://github.com/frapposelli/wwhrd> (and I suppose any
other tool using go-license <https://github.com/ryanuber/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 |LICENSE| → |LICENSE.code| would work too
(I guess, I've not actually tried it)
There is an issue on |go-license| at ryanuber/go-license#16
<ryanuber/go-license#16> but its from 2015
so I figured I would start here first.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#37>, or mute the
thread
<https://github.com/notifications/unsubscribe-auth/AAEF6fBwC-CQAX4giiDPj5AIcakeQhyAks5tsemsgaJpZM4Tlc4R>.
|
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 |
I'd added
Just renaming |
This allows automated tooling (such as license compatibilty checkers) to find it. Fixes opencontainers#37. Signed-off-by: Ian Campbell <[email protected]>
This is a misdetection, since fixed upstream in go-digest. See opencontainers/go-digest#37 Signed-off-by: Paul "TBBle" Hampson <[email protected]>
This is a misdetection, since fixed upstream in go-digest. See opencontainers/go-digest#37 Signed-off-by: Paul "TBBle" Hampson <[email protected]>
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 justLICENSE
(and leavingLICENSE.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 moreLICENSE.docs
specifically only coversREADME.md
andCONTRIBUTING.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
LICENSE
→LICENSE.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.The text was updated successfully, but these errors were encountered: