Merge branch 'master' into whitesource-step

documentation/docs/steps/handlePipelineStepErrors.md

@@ -26,3 +26,30 @@ handlePipelineStepErrors (stepName: 'executeHealthCheck', stepParameters: parame
     error "Health Check failed: ${statusCode}"
 }
 ```
+
+## Example console output
+
+If `echoDetails` is set to true the following information will be output to the console:
+
+1. Step beginning: `--- Begin library step: ${stepName}.groovy ---`
+1. Step end: `--- End library step: ${stepName}.groovy ---`
+1. Step errors:
+
+```log
+----------------------------------------------------------
+--- An error occurred in the library step: ${stepName}
+----------------------------------------------------------
+The following parameters were available to the step:
+***
+${stepParameters}
+***
+The error was:
+***
+${err}
+***
+Further information:
+* Documentation of step ${stepName}: .../${stepName}/
+* Pipeline documentation: https://...
+* GitHub repository for pipeline steps: https://...
+----------------------------------------------------------
+```

vars/handlePipelineStepErrors.groovy

@@ -12,29 +12,7 @@ import groovy.transform.Field
 @Field Set STEP_CONFIG_KEYS = []
 @Field Set PARAMETER_KEYS = [
     /**
-     * If set to true the following will be output to the console:
-     * 1. Step beginning: `--- Begin library step: ${stepName}.groovy ---`
-     * 2. Step end: `--- End library step: ${stepName}.groovy ---`
-     * 3. Step errors:
-     *
-     * ```log
-     * ----------------------------------------------------------
-     * --- An error occurred in the library step: ${stepName}
-     * ----------------------------------------------------------
-     * The following parameters were available to the step:
-     * ***
-     * ${stepParameters}
-     * ***
-     * The error was:
-     * ***
-     * ${err}
-     * ***
-     * Further information:
-     * * Documentation of step ${stepName}: .../${stepName}/
-     * * Pipeline documentation: https://...
-     * * GitHub repository for pipeline steps: https://...
-     * ----------------------------------------------------------
-     * ```
+     * If it is set to true details will be output to the console. See example below.
      * @possibleValues `true`, `false`
      */
     'echoDetails',