Update documentation

README.md

@@ -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

action.yml

@@ -12,9 +12,6 @@ inputs:
   directoryExclusionList:
     description: 'Filters out specific directories following a minimatch pattern.'
     required: false
-  ignoreDirectories:
-    description: 'Filters out specific directories, providing individual directory paths separated by semicolon. Obsolete in favor of DirectoryExclusionList''s glob syntax.'
-    required: false
   detectorArgs:
     description: '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.'
     required: false

componentDetection.ts

@@ -58,7 +58,6 @@ export default class ComponentDetection {
   private static getComponentDetectionParameters(): string {
     var parameters = "";
     parameters += (core.getInput('directoryExclusionList')) ? ` --DirectoryExclusionList ${core.getInput('directoryExclusionList')}` : "";
-    parameters += (core.getInput('ignoreDirectories')) ? ` --IgnoreDirectories ${core.getInput('ignoreDirectories')}` : "";
     parameters += (core.getInput('detectorArgs')) ? ` --DetectorArgs ${core.getInput('detectorArgs')}` : "";
     parameters += (core.getInput('detectorsFilter')) ? ` --DetectorsFilter ${core.getInput('detectorsFilter')}` : "";
     parameters += (core.getInput('dockerImagesToScan')) ? ` --DockerImagesToScan ${core.getInput('dockerImagesToScan')}` : "";

dist/index.js

@@ -23782,7 +23782,6 @@ class ComponentDetection {
     static getComponentDetectionParameters() {
         var parameters = "";
         parameters += (core.getInput('directoryExclusionList')) ? ` --DirectoryExclusionList ${core.getInput('directoryExclusionList')}` : "";
-        parameters += (core.getInput('ignoreDirectories')) ? ` --IgnoreDirectories ${core.getInput('ignoreDirectories')}` : "";
         parameters += (core.getInput('detectorArgs')) ? ` --DetectorArgs ${core.getInput('detectorArgs')}` : "";
         parameters += (core.getInput('detectorsFilter')) ? ` --DetectorsFilter ${core.getInput('detectorsFilter')}` : "";
         parameters += (core.getInput('dockerImagesToScan')) ? ` --DockerImagesToScan ${core.getInput('dockerImagesToScan')}` : "";