Skip to content
This repository was archived by the owner on Sep 6, 2023. It is now read-only.

Expand and update hook integration docs#350

Merged
Zero3141 merged 4 commits intosecureCodeBox:mainfrom
o1oo11oo:fix/hook-docs
Sep 4, 2023
Merged

Expand and update hook integration docs#350
Zero3141 merged 4 commits intosecureCodeBox:mainfrom
o1oo11oo:fix/hook-docs

Conversation

@o1oo11oo
Copy link
Copy Markdown
Contributor

@o1oo11oo o1oo11oo commented Sep 1, 2023

  • Use current node LTS in example Dockerfile
  • explain the scanparameter in JavaScript hooks
  • fix template helm docs syntax
  • add maketarget to generate docs

Closes #349

Lukas Fischer added 4 commits September 1, 2023 19:30
We upgraded our images to node 18 in secureCodeBox/secureCodeBox#1853,
this example file should mirror that.

Signed-off-by: Lukas Fischer <lukas.fischer@iteratec.com>
The hook sdk provides the hooks with an object containing information
about the details kubernetes stores about the scan resource. The section
documenting this object was empty before, this adds a description and an
example.

Signed-off-by: Lukas Fischer <lukas.fischer@iteratec.com>
Helm doc templates require no space between the opening braces and the
minus when removing whitespace.

Signed-off-by: Lukas Fischer <lukas.fischer@iteratec.com>
Signed-off-by: Lukas Fischer <lukas.fischer@iteratec.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Sep 1, 2023

Deploy Preview for docs-securecodebox ready!

Name Link
🔨 Latest commit 20ea64a
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/64f2267d16944e00083e82fe
😎 Deploy Preview https://deploy-preview-350--docs-securecodebox.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@o1oo11oo o1oo11oo self-assigned this Sep 1, 2023
@o1oo11oo o1oo11oo added the documentation Improvements or additions to documentation label Sep 1, 2023
@o1oo11oo
Copy link
Copy Markdown
Contributor Author

o1oo11oo commented Sep 1, 2023

One thing left open, in the issue I also mentioned that the template example is a bit barebones compared to most ScanCompletionHook yaml templates that we actually use. For implementing the Dependency-Track hook I compared the template to the ones used by DefectDojo and Elastic. Should we include more properties in the example or is what's listed enough?

@Zero3141 Zero3141 self-requested a review September 4, 2023 08:24
@Zero3141 Zero3141 merged commit 5e9ad7e into secureCodeBox:main Sep 4, 2023
@o1oo11oo o1oo11oo deleted the fix/hook-docs branch September 4, 2023 14:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

"Integrating a Hook" docs are outdated

2 participants