Skip to content

License auto detection #5

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

Open
achingbrain opened this issue Nov 28, 2024 · 0 comments
Open

License auto detection #5

achingbrain opened this issue Nov 28, 2024 · 0 comments
Labels
need/triage Needs initial labeling and prioritization

Comments

@achingbrain
Copy link
Member

achingbrain commented Nov 28, 2024

Following on from ipshipyard/p2p-forge#9 (comment) - posting here for better visibility.


From what I remember, we ended up with LICENSE, LICENSE-APACHE and LICENSE-MIT as that's what GitHub's automation detected at the time.

For the problems mentioned in the above linked thread:

  • LICENSE-APACHE - this is being detected as "unknown" in JS repos because by default we don't include the full text of the license, probably something we want to change.
  • LICENSE - this is also detected as unknown because it doesn't contain the text of any common license. It only exists to direct people to the apache/mit license files and can probably be removed now that GitHub detects the individual files separately.

Every js readme contains a License section that explicitly states the project is dual-licensed so the extra file is probably redundant?

The approach in this repo is interesting but the automatic license detection is a bit of a shoulder shrug:

image

Instead doing something like https://github.com/achingbrain/license-test gives you better detection and means you'll show up in searches for projects with a certain license:

image

Including the SPDX tag doesn't hurt but it doesn't trigger GitHub's license detection and according to the Linux Foundation you're supposed to add it to every file in your project (see "How do SPDX IDs work? - https://spdx.dev/learn/handling-license-info/ )

@achingbrain achingbrain added the need/triage Needs initial labeling and prioritization label Nov 28, 2024
@ipfs ipfs deleted a comment from welcome bot Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/triage Needs initial labeling and prioritization
Projects
None yet
Development

No branches or pull requests

1 participant