TeamCity integration: use Snyk in your build

For any project, you can add Snyk to your build to scan the code while you build and to fail the build for vulnerabilities, based on your configurations.

Snyk recommends running a build with the Snyk Security step before deployment, to ensure excellent security posture.

For additional information about TeamCity and its features, refer to the TeamCity documentation.

The following explains how to configure your build with a Snyk step.

• Add the Snyk step to a new or existing project:

  • For new projects, after configuring the Git repo from which to create the build, activate the auto-detect feature to automatically identify relevant steps for your project build.

  • For existing projects, navigate to edit the project build steps. When the Snyk step has been added, Snyk Security appears in the list of suggested steps and the current test policy appears in the Parameters Description column:

Snyk Security in the list of suggested build steps

• Navigate to configure the Snyk Security step as follows:

  • Click anywhere on the Snyk Security row to access the configuration screen, or

  • for existing projects, click Add build step to access the configuration screen.

Configure Snyk security for TeamCity

• Configure the TeamCity fields (Runner type, Step name, and Execute Step (an advanced option)).

• Optionally, click Show advanced options to display additional fields and Snyk parameters:

Additional Snyk parameters

• Configure Snyk Settings and Snyk Tool Settings. For more information see TeamCity configuration parameters.

• When the configuration is complete, run the build. When the Snyk Security step ends successfully, you can navigate to the Snyk Security Report tab to view results within TeamCity and to navigate to the Snyk UI for further action:

Snyk test report

• From the top of the report, click View on Snyk.io to view the snapshot and vulnerability information directly from the Snyk Web UI.