Skip to content

ci: add license checker #3

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Oct 6, 2025
Merged

ci: add license checker #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36c85ab
ci: add license checker
jamesbhobbs Oct 2, 2025
95e3453
ci: add license checker but use yarn
jamesbhobbs Oct 2, 2025
b2d8819
ci: npx the script
jamesbhobbs Oct 2, 2025
1f36a38
chore: tidy up
jamesbhobbs Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/check-licenses.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Check Licenses
on:
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 2, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Quote “on” to satisfy yamllint.

-on:
+'on':

As per static analysis hints.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
on:
'on':
🧰 Tools
🪛 YAMLlint (1.37.1)

[warning] 2-2: truthy value should be one of [false, true]

(truthy)

🤖 Prompt for AI Agents 
.github/workflows/check-licenses.yml around line 2: the top-level YAML key on is
unquoted and flagged by yamllint; update that line to quote the key (replace on:
with "on":) so the file uses a quoted key, then run a quick yamllint check to
confirm the warning is resolved.

push:
branches: ["main"]
pull_request:
branches: ["*"]
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 2, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Wildcard will miss branch names with slashes.

For pull_request, "*" won’t match branches like feature/foo. Use "**" or drop the filter.

-  pull_request:
-    branches: ["*"]
+  pull_request:
+    branches: ["**"]
🤖 Prompt for AI Agents 
.github/workflows/check-licenses.yml around line 6: the branches filter uses "*"
which does not match branch names containing slashes (e.g., feature/foo); update
the filter to use "**" (branches: ["**"]) or remove the branches filter entirely
so pull_request triggers run for all branches with slashes, and commit the
change to the workflow file.


concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
check_licenses:
name: Check Licenses
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

- name: Check Licenses
run: yarn check-licenses
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 2, 2025

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Use jlpm for consistency with repo tooling.

Most scripts use jlpm; align here.

-        run: yarn check-licenses
+        run: jlpm check-licenses
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
run: yarn check-licenses
run: jlpm check-licenses
🤖 Prompt for AI Agents 
.github/workflows/check-licenses.yml around line 23: the workflow runs the
license check with "yarn check-licenses" but the repo uses jlpm for package
script execution; update the step to use "jlpm check-licenses" instead of "yarn
check-licenses" so the workflow uses the same package manager wrapper as the
rest of the project.


1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"build:labextension:dev": "jupyter labextension build --development True .",
"build:lib": "tsc --sourceMap",
"build:lib:prod": "tsc",
"check-licenses": "npx license-checker-rseidelsohn --onlyAllow 'MIT;Apache-2.0;BSD-2-Clause;BSD-3-Clause;ISC;0BSD;CC0-1.0;Python-2.0;CC-BY-3.0;CC-BY-4.0;Unlicense;BlueOak-1.0.0;(MIT OR Apache-2.0);(MIT AND BSD-3-Clause);(Apache-2.0 OR MIT);(BSD-2-Clause OR MIT OR Apache-2.0);(MIT OR CC0-1.0);(MIT AND CC-BY-3.0);(Unlicense OR Apache-2.0)'",
"clean": "jlpm clean:lib",
"clean:lib": "rimraf lib tsconfig.tsbuildinfo",
"clean:lintcache": "rimraf .eslintcache .stylelintcache",
Expand Down