BST-3993: add scan_path option for monorepos (#9)

* Add scan_path option for monorepos

* update changelog

Author: JonathanSerafini

CHANGELOG.md

@@ -2,7 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
-## Unreleased - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.5..HEAD)
+## Unreleased - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.6..HEAD)
+
+## v4.0.6 - 2023-02-10 - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.5...v4.0.6)
+
+- Add scan\_path option
 
 ## v4.0.5 - 2022-10-24 - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.4...v4.0.5)
 

README.md

@@ -89,7 +89,13 @@ Optional identifier to uniquely identify the scanner
 
 ### `scan_label` (Optional, string)
 
-Optional identifier to identify a a monorepo component
+Optional identifier to identify a monorepo component
+
+### `scan_path` (Optional, string)
+
+Optional path within the git repository to execute scanners in.
+
+When this parameter is specified, you must also provide a `scan_label` to identify the component.
 
 ### `scan_timeout` (Optional, number)
 

action.yaml

@@ -39,6 +39,9 @@ inputs:
   scan_label:
     description: "Optional identifier to identify a a monorepo component"
     default: ""
+  scan_path:
+    description: "Optional relative path to scan"
+    default: ""
   scan_timeout:
     description: "Maximum amount of time a diff scan should complete in"
     default: ""
@@ -59,5 +62,6 @@ runs:
         BOOST_DIFF_SCAN_TIMEOUT: ${{ inputs.scan_timeout }}
         BOOST_PRE_SCAN: ${{ inputs.pre_scan_cmd }}
         BOOST_SCAN_LABEL: ${{ inputs.scan_label }}
+        BOOST_SCAN_PATH: ${{ inputs.scan_path }}
         BOOST_SCANNER_ID: ${{ inputs.scanner_id }}
         BOOST_SCANNER_REGISTRY_MODULE: ${{ inputs.registry_module }}