You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/new_security_scanner.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,14 +31,13 @@ Before opening a new issue, please make sure that we do not have any duplicates
31
31
## Steps to implement a new scanner
32
32
Hint: A general guide how to implement a new SCB scanner is documented [here](https://www.securecodebox.io/docs/contributing/integrating-a-scanner)
33
33
34
-
-[ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox/tree/master/scanners)
35
-
-[ ] Add a `README.gotmpl` and give a [brief overview](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/readme) of the scanner and its configuration options.
36
-
-[ ] Add a HelmChart and document all configuration options.
37
-
-[ ] Implement a new scanner specific `scan-type.yaml`
38
-
-[ ] Implement a new scanner specific `parse-definition.yaml`
39
-
-[ ] Add (optional) some `cascading-rules.yaml` like documented [here](https://www.securecodebox.io/docs/api/crds/cascading-rule)
40
-
-[ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on dockerHub
41
-
-[ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/parser-sdk) to implement a new findings parser (currently based on NodeJS)
34
+
-[ ] Create a new Helm Chart with the `make create-new-scanner NAME=new-scanner` command (replace `new-scanner` with the name of the scanner)
35
+
-[ ] Add a basic description of your scanner Helm chart in the `Chart.yaml`
36
+
-[ ] (optional) Add/Edit fields in `values.yaml`
37
+
-[ ] (optional) Add some cascading rules, see [here](https://www.securecodebox.io/docs/api/crds/cascading-rule/)
38
+
-[ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on DockerHub in the `scanner` directory
39
+
-[ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/main/parser-sdk) to implement a new findings parser (currently based on NodeJS) in the `parser` directory
42
40
-[ ] Add unit tests with at minimum 80% test coverage
43
41
-[ ] Add some example `scan.yaml` and `finding.yaml` files in the [example folder](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/examples-dir)
44
-
-[ ] Implement a [new integration or E2E test](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
42
+
-[ ] Implement a [new integration or E2E test](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/main/tests/integration)
43
+
-[ ] Add a brief overview of the scanner and its configuration options in `.helm-docs.gotmpl`
0 commit comments