debugReportArchive

Description

Archives the debug_report.txt artifact which facilitates analyzing pipeline errors by collecting information about the Jenkins environment in which the pipeline was run. There is a single config option 'shareConfidentialInformation' to enable including (possibly) confidential information in the debug report, which could be helpful depending on the specific error. By default this information is not included.

Parameters

name	mandatory	default	possible values
printToConsole	no
script	yes
shareConfidentialInformation	no	false	true, false

• printToConsole - Flag to enable printing the generated debug_report.txt also to the console.
• script - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.
• shareConfidentialInformation - Flag to control whether potentially confidential information will be included in the debug_report.txt. Default value is false. Additional information written to the log when this flag is true includes MTA modules, NPM modules, the GitHub repository and branch, the global extension repository if used, a shared config file path, and all used global and local shared libraries.

Step configuration

We recommend to define values of step parameters via config.yml file.

In following sections of the config.yml the configuration is possible:

parameter	general	step/stage
printToConsole
script
shareConfidentialInformation		X