Bug #23483: edit Foreman license info so that GitHub recognizes it - Foreman

Bug #23483

edit Foreman license info so that GitHub recognizes it

Added by Andrea Kao almost 5 years ago. Updated over 4 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Category:

Development tools

Target version:

1.19.0

Difficulty:

Triaged:

Bugzilla link:

Pull request:

https://github.com/theforeman/foreman/pull/5521

Fixed in Releases:

1.19.0

Found in Releases:

Red Hat JIRA:

Description

GitHub uses a library called Licensee to identify a project's license type. It shows this information in the status bar and via the API if it can unambiguously identify the license.

Currently, Licensee does not properly detect Foreman's license as GPL 3.0. When I run Licensee locally on the remote Foreman repo, here is the output I get:

$ licensee detect https://github.com/theforeman/foreman
License:        Other
Matched files:  LICENSE, README.md, package.json
LICENSE:
  Content hash:  a17b7fcbdc64255d04d0b05e6642373a8ccdf97f
  License:       Other
  Closest licenses:
    GPL-3.0 similarity:   77.68%
    AGPL-3.0 similarity:  74.68%
    LGPL-2.1 similarity:  53.60%
README.md:
  Content hash:  18f341307338ee217d08193931fa550b30ed563b
  License:       Other
  Closest licenses:
    WTFPL similarity:    5.00%
    MS-RL similarity:    2.34%
    BSL-1.0 similarity:  1.75%
package.json:
  Confidence:  90.00%
  Matcher:     Licensee::Matchers::NpmBower
  License:     GNU General Public License v3.0

Associated revisions

Revision 08bc2344 (diff)
Added by Andrea Kao almost 5 years ago

Fixes #23483: edit Foreman license info for GitHub UI

GitHub uses a library called Licensee to identify a project's license
type. It shows this information in the status bar and via the API if it
can unambiguously identify the license.

This commit modifies LICENSE so that it begins with the full text of
the GPL 3.0 license. The text that was previously at the beginning of
LICENSE has been moved to the relevant section of the README, which has
been renamed to "Licensing". At the bottom of the "Licensing" section,
there is a note that mentions to the reader that they can reference
LICENSE to see the full text of not only the GPL 3.0 license, but also
all licenses related to Foreman's dependencies.

Collectively, these changes allow Licensee to successfully identify the
license type of Foreman as GPL 3.0.

Signed-off-by: Andrea Kao <eirinikos@gmail.com>