Snyk integrates with CircleCI using a Snyk Orb, seamlessly scanning your application dependencies and Docker images for open source security vulnerabilities as part of the continuous integration/continuous delivery (CI/CD) workflow.
CircleCI enables users to easily create CI/CD workflows using a group of ready-to-use commands (Orbs) that can be added to your configuration file.
With the Snyk Orb, you can quickly add Snyk scanning to your CI/CD in order to test and monitor for open source vulnerabilities, based on your configurations. Results are then displayed from the CircleCI output view and can also be monitored from Snyk.io.
Getting started with CircleCI from scratch to a green build with Snyk is simple! You can read all about the Snyk Orb here:
Our Circle CI README - the page includes all the info that you need in order to set your CI/CD with Snyk including a list of parameters and samples.
A Circle CI blog - discussing how to set up a secure pipeline with the Snyk orb.
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.
Create a Snyk account and retrieve the Snyk API token from your Account settings.
Import the relevant repo into CircleCI.
Go to
Settings -> Security -> Orb security settingsand make sure you allow to opt-in to third party Orbs.Make sure your configuration (
config.yml) file follows version 2.1.Add the required variables to CircleCI (e.g. Snyk API token as
API_TOKEN)
-
From the Orbs registry, CircleCI displays a list of available Orbs customized for you directly, similar to the following image:
-
From this list, find and click the relevant #Snyk line to view the Orb's information with examples, parameters, and values:
