jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity

Merge branch 'master' into whitesource-step

Browse Source
This commit is contained in:
Sven Merk 2019-04-03 22:18:39 +02:00 committed by GitHub
commit dfa47ac4c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
documentation/docs/steps/handlePipelineStepErrors.md
View File

@ -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://...
----------------------------------------------------------
```

24
vars/handlePipelineStepErrors.groovy
View File

@ -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',