Update documentation

This commit is contained in:
Justin Hutchings
2023-01-22 20:03:17 +00:00
parent ef195183ad
commit 12357ddc15
5 changed files with 14 additions and 7 deletions
+13 -1
View File
@@ -23,4 +23,16 @@ jobs:
- uses: actions/checkout@v3
- name: Component detection
uses: jhutchings1/component-detection-action@v0.0.1
```
```
### Configuration options
| Parameter | Description | Example |
| --- | --- |
filePath | The path to the directory containing the environment files to upload. Defaults to Actions working directory. | `'.'`
directoryExclusionList | Filters out specific directories following a minimatch pattern. | `test`
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`
dockerImagesToScan |Comma separated list of docker image names or hashes to execute container scanning on | ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab |
detectorsFilter | A comma separated list with the identifiers of the specific detectors to be used. | `Pip, RustCrateDetector`
For more information: https://github.com/microsoft/component-detection