> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Coverity plugin

View this plugin on the Plugins site

coverityResults: Publish Coverity View Results

The Publish Coverity View Results step will retrieve issues from the configured Coverity Connect Instance, Project, and View. This step does not run any Coverity Analysis tools, it only retrieves the latest issues for the configured Project and View. It is recommended to run Coverity analyze and commit as prior step(s) in the pipeline to retrieve up to date results.

The Instance is configured in the Global Configuration, use the name of the instance or this step. The Project is the string name identifier of the Coverity Connect project. The View is the name or numeric ID of the view to retrieve issues from. Any filtering details for issue results this pipeline step will use can be configured in the Coverity Connect UI, it is recommended to use a custom "Issues: By Snapshot" view for this pipeline.

Note: if the are multiple streams in the project the view should be configured so the view filter uses only the stream for this pipeline. Additionally, it is recommended to filter the status value to not retrieve any Fixed or Dismissed issues.

  • connectInstance
    Select the Coverity Connect instance that should be used to fetch results. Instances can be added in the global configuration page under the Coverity section.
    • Type: String
  • connectView
    The Coverity Connect view that will be used to fetch the issues. This view should be configured to show issues for the project and stream which this pipeline is for.
    • Type: String
  • projectId

    The Coverity Connect Project to fetch issues from. Projects will be listed in the Coverity Connect UI under Configuration -> Projects & Streams or by using the top right search to view all projects. The plain text project name can be used here.

    Note: by default all Streams within a project will be used, so the View specified in conjunction with this value can filter the stream appropriately.

    • Type: String
  • abortPipeline (optional)
    Abort the pipeline run if issues are found in the specified view. Optional value which defaults to false.
    • Type: boolean
  • failPipeline (optional)
    Mark the pipeline run as a failure if issues are found in the specified view. Optional value which defaults to false.
    • Type: boolean
  • unstable (optional)
    Mark the pipeline run as unstable if issues are found in the specified view. Optional value which defaults to false.
    • Type: boolean

withCoverityEnv: Binds Coverity Tool path and Coverity Connect Instance information to Environment Variables

This step will use the specified Coverity Tool Installation and add the bin/ directory to PATH for any steps that are wrapped. This will allow the pipeline script to access Coverity tools (like cov-build, cov-analyze, and cov-commit-defects) directly from a script step (such as a Shell Script or Windows Batch Script). Also, this step optionally allows users to bind the Coverity Connect Instance information (Host/Port/Credentials) to environment variables.
  • coverityToolName
    • Type: String
  • connectInstance (optional)
    • Type: String
  • hostVariable (optional)
    Name of an environment variable to be set to the host of Coverity Connect during the build. Default environment variable name is "COVERITY_HOST" if not specified.
    • Type: String
  • passwordVariable (optional)
    Name of an environment variable to be set to the password for connection to Coverity Connect during the build. Default environment variable name is "COVERITY_PASSPHRASE" if not specified. The value of this environment variable will be masked with "******" in the Console Output of the build.
    • Type: String
  • portVariable (optional)
    Name of an environment variable to be set to the port for connection to Coverity Connect during the build. Default environment variable name is "COVERITY_PORT" if not specified.
    • Type: String
  • usernameVariable (optional)
    Name of an environment variable to be set to the username for connection to Coverity Connect during the build. Default environment variable name is "COV_USER" if not specified.
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.