Skip to main content

Snyk Node

This producer component that runs Snyk for JavaScript, TypeScript and Node.

Read more about what it does on the Snyk homepage and GitHub repo.

How to use with Smithy

Open-Source

  1. Add the Helm package to the pipeline settings:
---
# file: ./my-pipeline/kustomization.yaml
components:
- pkg:helm/smithy-security-oss-components/producer-snyk-node
  1. Configure the run parameter of the component in the pipeline run file.
# file: ./my-pipeline/pipelinerun.yaml
---
...
spec:
...
params:
- name: producer-snyk-node-api-key
value: <your snyk api key>

SaaS

  1. In the Smithy UI, open the page to create a new workflow.
  2. Find the Snyk Node in the Producers dropdown.
  3. Configure the parameters in the form on the right

Options

You can configure this component with the following options:

Option NameDescriptionDefaultType
[Required] producer-snyk-node-api-keySnyk API keyString