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.

Sonargraph Integration Jenkins Plugin

SonargraphReport: Sonargraph Integration Report Generation & Analysis

  • activationCode (optional)
    Sonargraph license activation code. If this parameter is not specified, you must specify a license file parameter.
    • Type: String
  • architectureViolationsAction (optional)
    • Type: String
  • architectureWarningsAction (optional)
    • Type: String
  • baselineReportPath (optional)
    Optional: Enter the path to the baseline Sonargraph XML report file (without extension ".xml"). This path must be relative to the workspace.
    • Type: String
  • chartConfiguration (optional)
    • Type: String
  • cyclicElementsAction (optional)
    • Type: String
  • emptyWorkspaceAction (optional)
    • Type: String
  • languageCPlusPlus (optional)
    Select if your Sonargraph system uses C++.
    • Type: boolean
  • languageCSharp (optional)
    Select if your Sonargraph system uses C#.
    • Type: boolean
  • languageJava (optional)
    Select if your Sonargraph system uses Java.
    • Type: boolean
  • languagePython (optional)
    Select if your Sonargraph system uses Python.
    • Type: boolean
  • licenseFile (optional)
    Sonargraph license file location. If this parameter is not specified, you must specify the activation code parameter.
    • Type: String
  • logFile (optional)
    Path of the log file to be used for SonargraphBuild (relative to workspace of Jenkins job). Default: sonargraph_build.log.
    • Type: String
  • logLevel (optional)
    Level of logging detail. One of: off, error, warn, info, debug, trace, all. Default: info.
    • Type: String
  • metaDataFile (optional)
    • Type: String
  • metrics (optional)
      Array / List of Nested Object
    • metricName
      • Type: String
    • metricCategory
      • Type: String
  • qualityGateAction (optional)
    • Type: String
  • qualityModelFile (optional)
    Optional: Use a built-in Quality Model, or an external Quality Model instead of the Quality Model included in Sonargraph Software System. Must be either a file within workspace with extension "sgqm", or one of the built-in Quality Models
    • Sonargraph:Default.sgqm (language-independent)
    • Sonargraph:Java.sgqm (language-specific)
    • Sonargraph:CSharp.sgqm (language-specific)
    • Sonargraph:CPlusPlus.sgqm (language-specific)
    • Type: String
  • reportGeneration (optional)
    • Type: String
  • reportPath (optional)
    Enter the path to the pre-generated Sonargraph XML report file (without extension ".xml"). This path must be relative to the workspace.
    • Type: String
  • skip (optional)
    Skip Sonargraph Jenkins Plugin.
    • Type: boolean
  • snapshotDirectory (optional)
    Target directory for the created snapshot. Only if either this parameter or snapshotFileName is provided, a snapshot will be generated. Parameter can only be used with Sonargraph Architect license.
    • Type: String
  • snapshotFileName (optional)
    The target file name (without extension). Only if either this parameter or snapshotDirectory is provided, a snapshot will be generated. Parameter can only be used with Sonargraph Architect license.
    • Type: String
  • sonargraphBuildJDK (optional)
    • Type: String
  • sonargraphBuildVersion (optional)
    • Type: String
  • systemDirectory (optional)
    Enter the path to the Sonargraph system (*.sonargraph) directory. This path must be relative to the workspace.
    • Type: String
  • thresholdViolationsAction (optional)
    • Type: String
  • unassignedTypesAction (optional)
    • Type: String
  • useHttpProxy (optional)
    Use Jenkins proxy configuration when connecting to Sonargraph license server.
    • Type: boolean
  • virtualModel (optional)
    The virtual model to be used when checking for issues. This parameter overrides the default virtual model that is set when the system is opened.

    Licensing

    Sonargraph Explorer Changing virtual models is not supported, "Parser" model is taken.
    Sonargraph Architect Changing virtual models is supported, "Modifiable.vm" is taken by default.
    • Type: String
  • workItemsAction (optional)
    • Type: String
  • workspaceProfile (optional)
    The profile file name (e.g. "BuildProfile.xml") for transforming the workspace paths to match the build environment.
    • Type: String
  • workspaceWarningsAction (optional)
    • 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.