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

Split license files for better recognition #12424

Merged
merged 1 commit into from
Apr 17, 2023
Merged

Conversation

msujew
Copy link
Member

@msujew msujew commented Apr 15, 2023

What it does

GitHub is using licensee to identify license information in repositories. The project identifies licenses on a per file basis and therefore has trouble with our double-license-in-one-file format.

I've split the LICENSE file into LICENSE-GPL and LICENSE-EPL, so that GitHub can correctly identify them. See this test repo where GitHub is able to successfully identify the two used licenses.

How to test

Merge this PR and assert that the license information in the repository is correctly updated.

Review checklist

Reminder for reviewers

@msujew msujew added the repo issues specific to the repository label Apr 15, 2023
Copy link
Contributor

@marcdumais-work marcdumais-work left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks Mark!

@msujew msujew merged commit 1334898 into master Apr 17, 2023
@msujew msujew deleted the msujew/license-fix branch April 17, 2023 14:12
@github-actions github-actions bot added this to the 1.37.0 milestone Apr 17, 2023
@msujew msujew linked an issue Apr 17, 2023 that may be closed by this pull request
@SpessartZiegler
Copy link

@msujew : In the file LICENSE (version 1.36.0) the was the GPL-2.0-with-classpath-exception (see line 625 ff). Now you split it. This is fine. But you copied a special classpath exception to LICENSE-GPL (see line 343 ff). Why did you add a special license from Oracle to Theia? I have searched and only in this file the name ORACLE appears.

Maybe you should replace this text by the original one from spdx.org and use the SPDX shot identifier GPL-2.0-with-classpath-exception for this.
grafik

@vince-fugnitto vince-fugnitto modified the milestones: 1.37.0, 1.38.0 May 25, 2023
@marcdumais-work
Copy link
Contributor

Thank you @SpessartZiegler - it's indeed wrong to have "GPL-2.0" detected for this repo. I will look into your suggestions!

@marcdumais-work
Copy link
Contributor

marcdumais-work commented May 31, 2023

@msujew I think we may have the root cause of the GitHub license detection issue: #12424 (comment) . The SPDX we've been using in various package.json files, for the secondary license, is not correct. It's also incorrect in all our source code header files, and the license name is mentioned wrong in many .md files. As also noticed by @SpessartZiegler, the text of our "GNU General Public License v2.0 w/Classpath exception" text has changed during the split, now looking like one that was customized by Oracle (contains an extra Oracle-specific paragraph).

I will open an issue about this.

@marcdumais-work
Copy link
Contributor

PR #12584

@marcdumais-work
Copy link
Contributor

marcdumais-work commented Jun 5, 2023

Thank you @SpessartZiegler - it's indeed wrong to have "GPL-2.0" detected for this repo. I will look into your suggestions!

update:
Now that I investigated this a bit deeper, I no longer think that it's necessarily wrong for GitHub to report "GPL-2.0" as a detected license. It's technically correct. I guess I hoped GitHub would detect [1] the exact "with classpath exception" variant of the license, but it does not and it's probably ok. (i.e. the detected license list is not the whole story, just a teaser)

[1]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#detecting-a-license

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo issues specific to the repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

repo: reporting incorrect license on homepage
5 participants