https://github.com/jmservera/license-finder-action
A GitHub Action for running Pivotal License Finder
https://github.com/jmservera/license-finder-action
Last synced: 5 months ago
JSON representation
A GitHub Action for running Pivotal License Finder
- Host: GitHub
- URL: https://github.com/jmservera/license-finder-action
- Owner: jmservera
- License: mit
- Created: 2022-11-03T08:21:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T14:42:04.000Z (over 2 years ago)
- Last Synced: 2024-12-16T02:53:13.680Z (5 months ago)
- Language: Java
- Size: 70.3 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# License Finder Action
A GitHub Action for running [Pivotal License Finder](https://github.com/pivotal/LicenseFinder)
## Inputs
### `permitted-licenses`
A comma separated list of licenses that are permitted. For example:
```yaml
permitted-licenses: MIT,Apache-2.0
```
### `approved-dependencies`
A comma separated list of dependencies that are approved
```yaml
approved-dependencies: jquery,bootstrap
```
### `report-name`
**Required** The name of the report to be generated.
Default: license_finder_report.xml
### `base-path`
**Required** If it is not in the root workspace parth, the base path with the code to review.
Default: ${{ github.workspace }}
## Usage
```yaml
uses: jmservera/[email protected]
with:
permitted-licenses: MIT,Apache-2.0
approved-dependencies: jquery,bootstrap
```
This action becomes useful when combined with some other actions like the
[upload artifact action](https://github.com/actions/upload-artifact)
and the [Publish unit test result action](https://github.com/EnricoMi/publish-unit-test-result-action)
```yaml
- name: 'License Scan'
uses: jmservera/[email protected]
with:
permitted-licenses: MIT,Apache-2.0
approved-dependencies: jquery,bootstrap
- name: Publish Test Results
uses: EnricoMi/[email protected]
if: always()
with:
junit_files: "license_finder_report.xml"
- name: 'Upload Dependency Review Report'
if: always()
uses: actions/upload-artifact@v2
with:
name: license-finder-report
path: license_finder_report.xml
```