Skip to content

new_hook.md

Latest commit

 

History

History
41 lines (33 loc) · 2.47 KB

new_hook.md

File metadata and controls

41 lines (33 loc) · 2.47 KB
name ⚓️ New Hook request
about Suggest an idea for a new data processing or integration hook in this project.
labels hook

⚓️ New Hook implementation request

Is your feature request related to a problem

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Steps to implement a new hook

Hint: A general guide how to implement a new SCB Hook is documented here

  • Create a new folder with the name of the hook here
  • Add a README.md and give a brief overview of the scanner and its configuration options.
  • Add a HelmChart and document all configuration options.
  • Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub.io
  • Use the Hook-SDK to implement a new hook (currently based on NodeJS)
  • Add unit tests with at minimum 80% test coverage
  • Add some example scan.yaml and finding.yaml files in the example folder
  • Implement a new integration or E2E test for the hook here