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

Licence check support/tooling #40

Open
mhdawson opened this issue Nov 26, 2021 · 14 comments
Open

Licence check support/tooling #40

mhdawson opened this issue Nov 26, 2021 · 14 comments
Labels
question Further information is requested

Comments

@mhdawson
Copy link
Member

The OpenJS foundation has good guidance/recommendations for Licences in the IP policy. -> https://openjsf.org/wp-content/uploads/sites/84/2019/10/OpenJS-Foundation-IP-Policy-2019-10-22.pdf

It would add value if we also had a well defined way/tooling to scan/check repos for licences. I expect this would be the case for other Foundations as well.

I think checks should include:

  1. Is there a licence (every repo should have one)
  2. What licence is stated and that it is one allowed by IP policy, along with a way the repo can indicate it is an exception
  3. No files within the repo reference a licence that is not in the IP policy

Ideally the tooling would allow a job to run periodically, that job would generate a summary and if there were new "failures" we could alert on that.

@brianwarner, @jorydotcom are you aware of any such tooling in place for any of the other Linux Foundation projects?

@mhdawson
Copy link
Member Author

mhdawson commented Jan 4, 2022

Discussion from CPC meeting today:

  • Jordan - repo-report (done through major league hacks), scans all repos that he has access to and.
    Could add license check.
  • Michael, that would be a great starting point.

Jordan will work with Michael to add license checks and we can go from there.

@ljharb
Copy link
Member

ljharb commented Jan 4, 2022

https://github.com/ljharb/repo-report could pretty easily add a "metric" for "has a license file, with an approved license"; happy to get that added (any other kind of community health files, as well, altho it'd need to take into account the repo's org/user's .github repo)

@ShubhraKar
Copy link

In LFX, we have license reporting by the repositories, packages, referencing manifest file for the libraries used in the core project as well as packages that are listed as dependencies in the manifest files (example package.json). However we we don't have a policy engine. We can implement that quickly if the community is open to collaborating.

Screen Shot 2022-01-10 at 4 53 15 PM

Screen Shot 2022-01-10 at 4 54 09 PM

@rginn
Copy link

rginn commented Jan 10, 2022

Thanks @ljharb and @ShubhraKar. I've invited Shubhra to our CPC meeting on Jan 18 to explore areas of collaboration on this tool. Cc: @mhdawson

@mhdawson
Copy link
Member Author

@rginn thanks that sounds good. I think adding to the common tool would be interesting.

@mhdawson
Copy link
Member Author

mhdawson commented Feb 15, 2022

  • Next step is for LF to respond on whether they are going to take ownership for providing something and if so, what timing would look like.

@joesepi
Copy link
Member

joesepi commented Mar 1, 2023

This was announced and is something LF IT should consider for this sort of effort.
openjs-foundation/cross-project-council#1017 (comment)

@joesepi
Copy link
Member

joesepi commented Mar 28, 2023

This could be good to have this sort of "checking" for two use cases:
- have the foundation run this on projects repos/org for licenses and coc and other requirements
- directions for projects (in cpc/project-resources directory) to run it themselves in their org to test regularly; as Michael Dawson said: Node.js creates repos regularly; would be good to run regularly to be sure licenses are present and acceptable

@ljharb
Copy link
Member

ljharb commented Mar 28, 2023

This can be done in CI, with https://npmjs.com/repo-report, and a github token that has write access or higher to all the relevant repos.

@joesepi

This comment was marked as resolved.

@ljharb ljharb transferred this issue from openjs-foundation/cross-project-council Jul 11, 2023
@bensternthal
Copy link
Contributor

Tagging in @vvalderrv and @tykeal this could be part of the infra workstream/in scope of that workstream.

@bensternthal
Copy link
Contributor

Added to Jira for IT https://jira.linuxfoundation.org/browse/RELENG-4796

@ruddermann ruddermann added the question Further information is requested label Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

7 participants