> 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.

Code Coverage API Plugin

View this plugin on the Plugins site

publishCoverage: Publish Coverage Report

  • adapters (optional)
      Array / List of Nested Choice of Objects
    • antPath
      • path
        • Type: String
    • dListingAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • istanbulCoberturaAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • jacocoAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • llvmAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • opencoverAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • sonarGenericCoverageAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • coberturaAdapter
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
    • cobertura
      • path
        • Type: String
      • mergeToOneReport (optional)
        • Type: boolean
      • thresholds (optional)
          Array / List of Nested Object
        • thresholdTarget
          • Type: String
        • failUnhealthy (optional)
          • Type: boolean
        • unhealthyThreshold (optional)
          • Type: float
        • unstableThreshold (optional)
          • Type: float
  • applyThresholdRecursively (optional)
    By default, this plugins will only apply threshold at report level. If this option is set to true, it will apply threshold to all levels. For example, if this option is true, and if you have specified a `Line` threshold, this plugin will check all modules, directories, files...
    • Type: boolean
  • calculateDiffForChangeRequests (optional)
    If it is a change request build, calculate code coverage diff with a target branch build
    • Type: boolean
  • failBuildIfCoverageDecreasedInChangeRequest (optional)
    Fail the build in case if code coverage decreased in comparison with the target branch
    • Type: boolean
  • failNoReports (optional)
    Fail the build if no coverage reports found.
    • Type: boolean
  • failUnhealthy (optional)
    Fail the build if coverage is lower than healthy threshold.
    • Type: boolean
  • failUnstable (optional)
    Fail the build if coverage is lower than stable threshold.
    • Type: boolean
  • globalThresholds (optional)
      Array / List of Nested Object
    • thresholdTarget
      • Type: String
    • failUnhealthy (optional)
      • Type: boolean
    • unhealthyThreshold (optional)
      • Type: float
    • unstableThreshold (optional)
      • Type: float
  • skipPublishingChecks (optional)
    If unchecked, the plugin will automatically publish the coverage to corresponding SCM platforms. For example, if you are using this feature for a GitHub organization project, the coverage will be published to GitHub through the Checks API.
    • Type: boolean
  • sourceFileResolver (optional)
      Nested Object
    • level
      • Values: NEVER_STORE, STORE_LAST_BUILD, STORE_ALL_BUILD
  • tag (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.