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

Make sure repository license can be correctly detected #1333

Merged
merged 5 commits into from
Feb 14, 2023
Merged

Make sure repository license can be correctly detected #1333

merged 5 commits into from
Feb 14, 2023

Conversation

wiegandm
Copy link
Member

What:

Individual files describing the license status of this module have been renamed to ensure correct license detection by GitHub.

Why:

Currently, GitHub is unable to determine the license of this repository since the file COPYING does not contain the text of a license, but rather details on the licensing of individual source code file.

This leads to the license being displayed as Unknown, GPL-2.0 licenses found in the GitHub web interface and as:

    "licenseInfo": {
      "key": "other",
      "name": "Other",
      "nickname": ""
    },

when retrieved via the API.

Having the license detectable by GitHub makes it easier for both developers and automated processes to assess the licensing.

How:

As GitHub seems to not do license detection on branches, I used the licensee ruby gem to validate the file.
Before:

COPYING:
  Content hash:  1761efd6e733621f80c7303f70ab83eede5641e1
  License:       NOASSERTION
  Closest non-matching licenses:
    Vim similarity:           11.39%
    OFL-1.1 similarity:       7.53%
    MulanPSL-2.0 similarity:  6.90%

After:

COPYING:
  Content hash:  2bad07668a4461ecadbfc380652eba2a0db5112c
  Confidence:    99.83%
  Matcher:       Licensee::Matchers::Dice
  License:       GPL-2.0
  Closest non-matching licenses:
    GPL-2.0 similarity:  99.83%
    MPL-2.0 similarity:  44.39%
    EPL-2.0 similarity:  38.26%

Checklist:

  • Tests N/A
  • PR merge commit message adjusted

@wiegandm wiegandm requested a review from a team as a code owner February 14, 2023 10:52
@y0urself y0urself merged commit 65c5aaf into greenbone:main Feb 14, 2023
mergify bot pushed a commit that referenced this pull request Feb 14, 2023
* Move licensing details to separate file

* Add Markdown formatting to license details file

* Update link to license details in README

* Rename files to ensure COPYING contains license

This is done in line with the GitHub documentation to ensure that the
effective repository license can be correctly detected by GitHub.

* Update links to match file renaming

(cherry picked from commit 65c5aaf)
ArnoStiefvater pushed a commit that referenced this pull request Feb 14, 2023
…1334)

* Move licensing details to separate file

* Add Markdown formatting to license details file

* Update link to license details in README

* Rename files to ensure COPYING contains license

This is done in line with the GitHub documentation to ensure that the
effective repository license can be correctly detected by GitHub.

* Update links to match file renaming

(cherry picked from commit 65c5aaf)

Co-authored-by: Michael Wiegand <wiegandm@users.noreply.github.com>
@wiegandm wiegandm deleted the license_declaration branch February 14, 2023 13:24
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

Successfully merging this pull request may close these issues.

3 participants