-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
[CI] Automate license check reviews #11766
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcdumais-work
added
ci
issues related to CI / tests
eclipse
issues related to eclipse / eclipse foundation
labels
Oct 13, 2022
OOPS - I will see what I can do about |
In this PR we introduce the option to use our license check tool, "dash-licenses", in "Automatic IP Team Review Requests" mode [1]. In this mode, any dependency that's found to have an unclear or suspicious license will be automatically submitted to the Eclipse Foundation for review. Each such dependency will have a ticket opened on the Foundation's Gitlab and be automatically reviewed. If the automated review is not conclusive, a manual assessment will be performed by the Foundation's IP team. In our experience, most dependencies are approved automatically within minutes. To perform a license check with automated reviews, use the new script: $> yarn license:check:review To perform the license check without the automated review, do as before: $> yarn license:check Note: for review mode to work, a Personal Access Token from the Foundation's Gitlab is required, created from a project committer's Gitlab profile. Set it in an environment variable named "DASH_LICENSES_PAT". E.g. in bash: $> export DASH_LICENSES_PAT=<token> [1] https://github.com/eclipse/dash-licenses#automatic-ip-team-review-requests Signed-off-by: Marc Dumais <[email protected]>
In our license check workflow, make use of the new yarn script "license:check:review". I have set the required Gitlab Personal Access Token as a repo secret using the GitHub API (we do not have UI access to this setting). Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
force-pushed
the
automate-license-check-reviews
branch
from
October 13, 2022 18:08
f5daa9a
to
db6926f
Compare
paul-marechal
approved these changes
Oct 13, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Logic LGTM, I only pushed styling and cleanup changes.
Avoid using `shell: true` as I had bad experiences with it on Windows. Instead sanitize arguments to hide secrets when prompting.
paul-marechal
force-pushed
the
automate-license-check-reviews
branch
from
October 13, 2022 19:19
91fa23c
to
6fb777e
Compare
marcdumais-work
force-pushed
the
automate-license-check-reviews
branch
from
October 13, 2022 19:29
e34e0c7
to
6fb777e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
Introduce automated license check reviews
In this PR we introduce the option to use our license check tool,
"dash-licenses", in "Automatic IP Team Review Requests" mode [1].
In this mode, any dependency that's found to have an unclear or
suspicious license will be automatically submitted to the Eclipse
Foundation for review. Each such dependency will have a ticket opened
on the Foundation's Gitlab and be automatically reviewed. If the
automated review is not conclusive, a manual assessment will be
performed by the Foundation's IP team.
In our experience, most dependencies are approved automatically
within minutes.
To perform a license check with automated reviews, use the new script:
To perform the license check without the automated review, do as before:
Note: for review mode to work, a Personal Access Token from the Foundation's
Gitlab is required, created from an Eclipse committer's Gitlab profile. I went ahead and
set one as a GitHub secret, for this repo.
Set it in an environment variable named "DASH_LICENSES_PAT". E.g. in bash:
[1] https://github.com/eclipse/dash-licenses#automatic-ip-team-review-requests
P.S. we obtained permission to do this a while ago.
How to test
yarn license:check
still works like beforeyarn license:check:review
works as expected:"btoa": "1.2.1"
can be used currently as a suspicious dependency for testing purposes - add it to rootpackage.json
and runyarn
Review checklist
Reminder for reviewers