https://github.com/onebeyond/license-checker-action
🕵️ Audit your NPM dependencies and reject any forbidden license.
https://github.com/onebeyond/license-checker-action
hacktoberfest
Last synced: about 1 month ago
JSON representation
🕵️ Audit your NPM dependencies and reject any forbidden license.
- Host: GitHub
- URL: https://github.com/onebeyond/license-checker-action
- Owner: onebeyond
- Created: 2023-07-04T08:39:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T17:13:41.000Z (over 2 years ago)
- Last Synced: 2025-01-14T23:32:48.048Z (over 1 year ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 256 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# npm license-checker-action javascript action
This action prints check licenses of npm dependencies and makes the workflow to pass/fail depending on the result.
## Inputs
### `failOn`
**Required** Fail (exit with code 1) if any package license does not satisfies any license in the provided list.
### `start`
Path of the initial json to look for. Default to the working directory
### `outputFilename`
Name of the output file generated
### `errorReportFileName`
Name of the file generated when a license in the failOn option is found
### `disableErrorReport`
Flag to disable the error report file generation
### `disableReport`
Flag to disable the report file generation, whether there is an error or not
### `customHeader`
Name of a text file containing the custom header to add at the start of the generated report
## Example usage
```yaml
uses: # Waiting until publishing
with:
failOn: ["GPL-1.0-or-later", "AGPL-3.0"]
```
## TODO
- Add husky pre-push hook for building and comiting the /dist folder before pushing
- Could it be done in a GA instead?
- Add a GA for testing, linting and checking format
-