jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-03-03 15:02:35 +02:00
Code Issues Releases Activity

Merge pull request #639 from alejandraferreirovidal/fixDocu

Browse Source 
fix docu
This commit is contained in:
Alejandra Ferreiro Vidal 2019-04-04 11:22:03 +02:00 committed by GitHub
commit fa656fd36c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6,6 +6,10 @@
none
## ${docGenParameters}
## ${docGenConfiguration}
## Example
```groovy
@ -13,7 +17,7 @@ handlePipelineStepErrors (stepName: 'executeHealthCheck', stepParameters: parame
def url = new Utils().getMandatoryParameter(parameters, 'url', null)
def statusCode = curl(url)
if (statusCode != '200')
error "Health Check failed: ${statusCode}"
error "Health Check failed: \${statusCode}"
}
```
@ -31,19 +35,15 @@ If `echoDetails` is set to true the following information will be output to the
----------------------------------------------------------
The following parameters were available to the step:
***
${stepParameters}
\${stepParameters}
***
The error was:
***
${err}
\${err}
***
Further information:
* Documentation of step ${stepName}: .../${stepName}/
* Documentation of step \${stepName}: .../\${stepName}/
* Pipeline documentation: https://...
* GitHub repository for pipeline steps: https://...
----------------------------------------------------------
```
## ${docGenParameters}
## ${docGenConfiguration}