New Features
  1. Docs Library | Snyk
  2. Integrations
  3. CI/CD integrations

Articles in this section

See more

Configure your CircleCI integration

Once the user adds a project to CircleCI and adds the Snyk Orb to the configuration file, every time that a build will run, the Snyk Orb will be used as well.

Scan

  1. Scans app dependencies or container images for vulnerabilities or licensing issues, and lists them.

  2. If Snyk finds vulnerabilities, it does one of the following (based on configuration):

    • Fails the build

    • Lets the build complete

Monitor

Optionally, if the build completes successfully and MONITOR is set to True in the Snyk step, then Snyk saves a snapshot of the project dependencies from the Snyk app, where you can view the dependency tree displaying all of the issues, and you can receive alerts for new issues found in the existing app version.

Protect (optional)

(For Node.js projects only) Optionally, set PROTECT to True and if a .snyk policy file exists, Snyk applies patches specified in the policy file.

Prerequisites

  1. Create a Snyk account and retrieve the Snyk API token from your Account settings.

  2. Import the relevant repo into CircleCI.

  3. Go to Settings -> Security -> Orb security settings and make sure you allow to opt-in to third party Orbs.

  4. Make sure your configuration (config.yml) file follows version 2.1.

  5. Add the required variables to CircleCI (e.g. Snyk API token as API_TOKEN)