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.

Forensics API Plugin

View this plugin on the Plugins site

mineRepository: Mine SCM repository

  • scm : String (optional)
    Specify the key of your repository (substring is sufficient) if you are using multiple SCMs in your job. When your job is composed of several SCM checkouts (modules, pipeline libraries, etc.) then Jenkins stores all those repositories in an unsorted way.

discoverReferenceBuild: Discover reference build

  • considerRunningBuild : boolean (optional)
    If enabled, then running builds will be considered as reference build as well. Otherwise, only completed builds are considered. Enabling this option might cause problems if the reference build has not yet all the required results available.
  • referenceJob : String (optional)

    The reference job is the baseline used to determine the relative differences to the current build. Several plugins that report build statistics (test results, code coverage, metrics, static analysis warnings) typically show their reports in two different ways: either as absolute report (e.g., total number of tests or warnings, overall code coverage) or as relative delta report (e.g., additional tests, increased or decreased coverage, new or fixed warnings). To compute a relative delta report, a plugin needs to select another build to compare the current results to (a so-called reference build). This reference build is obtained from the specified reference job.

    In Multibranch Pipelines this parameter can be left empty: in these jobs, the plugin selects the build automatically from the associated job that builds the main target branch. For all other jobs, the last completed build of the current job will be used as reference build if the reference job is not specified.

  • requiredBuildResult : String (optional)
    When a reference build is searched for in the baseline (see the parameter reference job) then it sometimes makes sense to only consider builds that have a certain result. For example, you may want to skip the computation of a delta coverage when the reference build has failed tests. Or you may want to skip the computation of new warnings when the reference build has a compilation error. The following enumeration shows the possible values for this parameter and the corresponding behavior:
    SUCCESS
    The selected build must be successful
    UNSTABLE
    The selected build must be successful or unstable
    FAILURE
    The result of the build is not relevant (this is the default behavior if unset)
  • requiredResult : String (optional)
    When a reference build is searched for in the baseline (see the parameter reference job) then it sometimes makes sense to only consider builds that have a certain result. For example, you may want to skip the computation of a delta coverage when the reference build has failed tests. Or you may want to skip the computation of new warnings when the reference build has a compilation error. The following enumeration shows the possible values for this parameter and the corresponding behavior:
    SUCCESS
    The selected build must be successful
    UNSTABLE
    The selected build must be successful or unstable
    FAILURE
    The result of the build is not relevant (this is the default behavior if unset)

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.