Skip to content

Commit 5ea1675

Browse files
committed
Add optional dependencies example in README
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
1 parent fdeb9b4 commit 5ea1675

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ from your **GitHub Workflows**.
2525
- [Check for compliance issues](#check-for-compliance-issues)
2626
- [Define a custom project name](#define-a-custom-project-name)
2727
- [Install ScanCode.io from a repository branch](#install-scancodeio-from-a-repository-branch)
28+
- [Install ScanCode.io with optional dependencies](#install-scancodeio-with-optional-dependencies)
2829
- [Run source to binary mapping](#run-source-to-binary-mapping)
2930
- [Where does the scan results go?](#where-are-the-scan-results)
3031

@@ -227,6 +228,14 @@ Activate this behavior by enabling `check-compliance` and setting
227228
scancodeio-repo-branch: "main"
228229
```
229230

231+
### Install ScanCode.io with optional dependencies
232+
233+
```yaml
234+
- uses: aboutcode-org/scancode-action@beta
235+
with:
236+
scancodeio-extras: "android_analysis,mining"
237+
```
238+
230239
### Run source to binary mapping
231240

232241
Use this [workflow template](.github/workflows/map-deploy-to-develop-template.yml) for validating the integrity of open-source binary. It compares a project’s binary to its source code. Workflow will generate mapping between compiled binary and its original source code, which helps in spotting any malicious, unexpected, or otherwise undesirable code that may have made its way into the final binary.

0 commit comments

Comments
 (0)