Configuring a Code Sight client to access Black Duck scan engines via a Coverity on Polaris server involves two distinct configuration files.

For a Code Sight installation that accesses Black Duck scan engines via Coverity on Polaris, each configuration file has its own purpose.

The polaris.yml file

The polaris.yml file is a YAML file that is standard for Coverity on Polaris installations.

To configure a Code Sight client, you need to specify the serverUrl and the project sections of polaris.yml

For more information about the configuration file, please see the section Coverity on Polaris Help → “Command Line” → “Configuration File Overview”.

Please keep in mind the following:

  • For Code Sight configuration, you do not need to edit other sections of polaris.yml.
  • The polaris.yml is a standard component of Coverity on Polaris configurations, so this file might already be present in your code base.

    If your code base has not used Coverity on Polaris before, you might need to create a new polaris.yml file. You can use the Coverity on Polaris command-line interface to do so. For a description of the steps to follow, please see the section Coverity on Polaris Help → “Command Line” → “Command Line Overview” → “CLI Scanning QuickStart Guide” → “Initialize a Project”.

  • Code Sight retrieves only URL, project, branch, and revision information from polaris.yml. Any local custom compiler configuration or custom analysis settings must be done via coverity.conf.

The coverity.conf file

Project-specific coverity.conf files are JSON files that are specifically for configuring Coverity Analysis and Coverity Connect behavior. If you are using a Coverity on Polaris server and you do not need to customize Coverity Analysis behavior, then you do not need to create or modify project-specific coverity.conf files, and with Coverity on Polaris there is no need for a user-specific coverity.conf file.

CAUTION: If your client connects via a Coverity on Polaris server, do not use the coverity.conf file’s "server" or "stream" fields. The Coverity on Polaris "server" and "project" values are specified in the polaris.yml file.

For a site that uses a Coverity on Polaris server, there are only a few reasons you might want to use a project-specific coverity.conf. The most common of these are:

  • To specify a compiler configuration that is not the standard configuration for the IDE you use.
  • To specify custom Coverity Analysis settings.

These circumstances are described in Alternative configuration settings.

For more detailed information about the format of coverity.conf and the options it supports, please see the Coverity Desktop Analysis User Guide.