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.

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

docs: fix npm-license-checker documentation #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix npm-license-checker documentation #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23c37af
docs: fix npm-license-checker documentation
thuey Dec 13, 2024
9f6eaff
Update Node.js version to 20 in README
thuey Dec 13, 2024
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
36 changes: 30 additions & 6 deletions .github/actions/npm-license-checker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,41 @@
# npm-license-checker
A GitHub action to check 3rd-party licenses and output a report of licenses used

## Inputs
| Name | Required | Description | Default |
| ---- | -------- | ----------- | ------- |
| `dependency-type` | No | Type of dependencies to include: production \| development \| all | `all` |
| `start-path` | No | The path to begin scanning for licenses | `./` |
| `custom-fields-path` | No | A path to a file to customize the detail output. See: https://www.npmjs.com/package/license-checker-rseidelsohn#custom-format | NA |
| `clarifications-path` | No | A path to a file that contains license clarifications. See: https://www.npmjs.com/package/license-checker-rseidelsohn#clarifications | NA |
| `only-allow` | No | A semicolon-separated list of allowed licenses | [List of common open source licenses] |
| `details-output-path` | No | The path to output details (e.g. ./licenseData.json) | NA |
| `details-output-format` | No | The format to output the results in (csv \| json \| markdown) | `json` |
| `exclude-packages` | No | A comma-separated list of packages to exclude | NA |
| `exclude-packages-starting-with` | No | A comma-separated list of package name prefixes to exclude | NA |

## Example usage
```yaml
name: Generate Third-Party Credits

on:
push:
branches: - '\*\*' - '!master' - '!release' - '!develop'
push:
branches:
- '**'
- '!master'
- '!release'
- '!develop'

jobs:
generate-credits:
runs-on: ubuntu-latest
steps: - uses: actions/checkout@v4
generate-credits:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'

- name: Install dependencies
run: npm ci
Expand All @@ -32,3 +55,4 @@ steps: - uses: actions/checkout@v4
with:
commit_message: 'Update credits.json'
file_pattern: './app/src/credits.json'
```
Loading