Node.js License Checker

It's a GitHub Action which helps you to find unallowed licenses in your project.

Example

name: Check Licenses
on:
  push:
    branches: [main]
    # Run this action only if dependencies has changed
    paths:
      - 'yarn.lock'
  pull_request:
    paths:
      - 'yarn.lock'
jobs:
  licenses:
    name: Check licenses
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      # Install only production dependencies
      # if you don't care about licenses of devDependencies
      # E.g. GPL license is allowed in devDependencies
      - run: yarn --frozen-lockfile --production

      # Use main branch or a specific version (e.g. @v0.2.0)
      - uses: daynin/nodejs-license-checker@main
        with:
          exclude-private-packages: true
          allow-only:  |
            MIT
            BSD-3-Clause
            ISC

Input parameters

See supported input parameters list in action.yml. Most of them are passed to license-checker, so you can check options description and examples there or submit a PR passing a new option.

Contributing

Don't forget to build changes and push them to GitHub (dist folder).