jenkinsMaterializeLog

Description

This step allows you to materialize the Jenkins log file of the running build.

It acts as a wrapper executing the passed function body.

Note: the file that has been created during step execution will be removed automatically.

Prerequisites

None

Example

jenkinsMaterializeLog script:this, { name -> println "log file: " + name }

Parameters

name	mandatory	default	possible values
script	yes

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

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
script

Dependencies

The step depends on the following Jenkins plugins

• pipeline-utility-steps
• workflow-basic-steps
• workflow-cps-global-lib

Transitive dependencies are omitted.

The list might be incomplete.

Consider using the ppiper/jenkins-master docker image. This images comes with preinstalled plugins.