BST-2963: scan id label (#7)

* add scanner_id and scan_label options
* release version 4.0.4

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.3..HEAD)
+## Unreleased - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.4..HEAD)
+
+## v4.0.4 - 2022-10-24 - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.3...v4.0.4)
+
+- Add scanner\_id and scan\_label options
 
 ## v4.0.3 - 2022-10-10 - [Github](https://github.com/boostsecurityio/boostsec-scanner-github/compare/v4.0.2...v4.0.3)
 

README.md

@@ -83,6 +83,14 @@ additional files that are not tracked in git.
 The relative path towards a module within the [Scanner Registry](https://github.com/boostsecurityio/scanner-registry).
 To streamline the configuration, both the _scanners_ prefix and _module.yaml_ suffix may be omitted.
 
+### `scanner_id` (Optional, string)
+
+Optional identifier to uniquely identify the scanner
+
+### `scan_label` (Optional, string)
+
+Optional identifier to identify a a monorepo component
+
 ### `scan_timeout` (Optional, number)
 
 The optional timeout after which the Github check will be marked as failed. This defaults to 120 seconds.

action.yaml

@@ -33,6 +33,12 @@ inputs:
   registry_module:
     description: "Module within the scanner registry to execute"
     required: true
+  scanner_id:
+    description: "Optional identifier to uniquely identify the scanner"
+    default: ""
+  scan_label:
+    description: "Optional identifier to identify a a monorepo component"
+    default: ""
   scan_timeout:
     description: "Maximum amount of time a diff scan should complete in"
     default: ""
@@ -52,4 +58,6 @@ runs:
         BOOST_LOG_LEVEL: ${{ inputs.log_level }}
         BOOST_DIFF_SCAN_TIMEOUT: ${{ inputs.scan_timeout }}
         BOOST_PRE_SCAN: ${{ inputs.pre_scan_cmd }}
+        BOOST_SCAN_LABEL: ${{ inputs.scan_label }}
+        BOOST_SCANNER_ID: ${{ inputs.scanner_id }}
         BOOST_SCANNER_REGISTRY_MODULE: ${{ inputs.registry_module }}