License checker action

This action extracts licence information for all installed packages. It is configurable to exclude all indirect dependencies as well as excluding by name prefix.

Usage

Prerequisites

Packages have to be installed to the root working directory in folder node_modules. If the option direct_dependencies_only is used the package.json file also has to be present in the root.

workflow.yml Example

Place in a .yml file such as this one in your .github/workflows folder. Refer to the documentation on workflow YAML syntax here.

name: Extract license data

on: [pull_request]

jobs:
  upload:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: actions/setup-node@v3
        with:
          node-version-file: '.nvmrc'
      - name: Clean npm install
        run: npm ci
      - uses: sellpy/license-checker@main
        with:
          exclude_prefix: '@sellpy'
          direct_dependencies_only: true
          omit_package_versions: true
          output_file_path: 'packages-license-data.json'

Action inputs

Name	Required	Default value	Description
exclude_prefix	-	-	Exclude packages from license check by giving a prefix.
direct_dependencies_only	✔️	-	Only include direct dependencies.
omit_package_versions	✔️	-	Omit package versions in output.
output_file_path	-	"packages-license-info.json"	Path to output file (needs to use file extension .json).