Configuration File Schema

Coverity on Polaris

Version
latest
This consolidated schema uses example data and paths for clarity. Your configuration file will have settings specific to your project.

Schema

version: "1"
project: 
  organization: <orgName>
  name: <ProjectName> 
  branch: <branchName>
  revision:
    name: doc-examples-java
    date: "2021-08-16T05:12:39Z"
    modified: false
  captureDir: "/Users/path/captureDir"
  projectDir: "/Users/path/projectDir"
  scmUrl: "https://github.com/test/simplejava.git"
  properties:
    key1: 162918
    key2: 16291840
    key3: 1629184067
    key4: 162918406779
    key5: 1629184067794h
  groups:
    Group1: "Observer"
    Group2: "Administrator"
    Group3: "Contributor"
capture:
  build:
    cleanCommands:
    - shell: [clean-command-component1, clean-command-component2, clean-command-component3...]
    buildCommands:
    - shell: [build-command-component1, build-command-component2, build-command-component3...]
    coverity:
      cov-build:
      - "<--option1>"
      - "<value1>"
      - "<--option2>"
      skipFiles:
      - "@File1"
      - "File2"
      cov-configure: 
      - "<--option1>"
      - "<value1>"
      - "<--option2>" 
  fileSystem: 
    language: 
      extensions: [extension] 
      files: 
      - directory: /directory
  coverity:
    idirCapture:
      idirPath: "/path/to/existing/idir"
    buildless:
      project:
        languages:
        - "java"
        - "javascript"
      sourceMode:
        sourceDirOptions:
        - "<--option1>"
        - "<value1>"
        - "<--option2>"
        - "<value2>"
        sourceDir: "source/directory/path/"
     autoCapture: "enable" | "disable"
     cov-security-da: "enable" | "disable"
install:
  coverity:
    version: "2021.06"
    directory : "/path/to/already/installed/coverity/coverity-tools-macosx-2021.06-1"
analyze:
  mode: "local" | "central"
  coverity:
    cov-analyze:
    - "<--option1>"
    - "<value1>"
    - "<--option2>"
    caching:
      dlls: "disable" | "enable"
      jars: "disable" | "enable"
      pfi: "disable" | "enable"
      rws: "disable" | "enable"
      tu-caching: "disable" | "enable"
    usebudaforjavadotnet: "disable" | "enable"	
 serverUrl: <serverUrl> 
 uploadServiceUrl: <uploadServiceURL>
 noLogEnvironmentVariable: "disable" | "enable"