Skip to content

Commit 81fde65

Browse files
committed
Add new input to readme
1 parent 786fb5f commit 81fde65

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Component detection dependency submission action
22

3-
This GitHub Action runs the [microsoft/component-detection](https://github.com/microsoft/component-detection) library to automate dependency extraction at build time. It uses a combination of static and dynamic scanning to build a dependency tree and then uploads that to GitHub's dependency graph via the dependency submission API. This gives you more accurate Dependabot alerts, and support for a bunch of additional ecosystems.
3+
This GitHub Action runs the [microsoft/component-detection](https://github.com/microsoft/component-detection) library to automate dependency extraction at build time. It uses a combination of static and dynamic scanning to build a dependency tree and then uploads that to GitHub's dependency graph via the dependency submission API. This gives you more accurate Dependabot alerts, and support for a bunch of additional ecosystems.
44

55
### Example workflow
66

@@ -12,7 +12,7 @@ on:
1212
workflow_dispatch:
1313
push:
1414

15-
permissions:
15+
permissions:
1616
id-token: write
1717
contents: write
1818

@@ -21,19 +21,20 @@ jobs:
2121
runs-on: ubuntu-latest
2222
steps:
2323
- uses: actions/checkout@v3
24-
- name: Component detection
24+
- name: Component detection
2525
uses: advanced-security/component-detection-dependency-submission-action@v0.0.3
26-
```
26+
```
2727
2828
### Configuration options
2929
30-
| Parameter | Description | Example |
31-
| --- | --- | --- |
30+
| Parameter | Description | Example |
31+
| --- | --- | --- |
3232
filePath | The path to the directory containing the environment files to upload. Defaults to Actions working directory. | `'.'`
3333
directoryExclusionList | Filters out specific directories following a minimatch pattern. | `test`
3434
detectorArgs | Comma separated list of properties that can affect the detectors execution, like EnableIfDefaultOff that allows a specific detector that is in beta to run, the format for this property is DetectorId=EnableIfDefaultOff, for example Pip=EnableIfDefaultOff. | `Pip=EnableIfDefaultOff`
35-
dockerImagesToScan |Comma separated list of docker image names or hashes to execute container scanning on | ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab |
35+
dockerImagesToScan |Comma separated list of docker image names or hashes to execute container scanning on | ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab |
3636
detectorsFilter | A comma separated list with the identifiers of the specific detectors to be used. | `Pip, RustCrateDetector`
37+
detectorsCategories | A comma separated list with the categories of components that are going to be scanned. The detectors that are going to run are the ones that belongs to the categories. The possible values are: Npm, NuGet, Maven, RubyGems, Cargo, Pip, GoMod, CocoaPods, Linux. | `Npm,Maven,Pip`
3738
correlator | An optional identifier to distinguish between multiple dependency snapshots of the same type. Defaults to the [job_id](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_id) of the current job | `csharp-backend`
3839

3940
For more information: https://github.com/microsoft/component-detection

0 commit comments

Comments
 (0)