1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
sap-jenkins-library/template/step.md

43 lines
678 B
Markdown
Raw Normal View History

2017-07-11 15:12:03 +02:00
# <step name>
## Description
Brief description.
2017-07-11 15:12:03 +02:00
## Prerequisites
2017-07-11 15:12:03 +02:00
* **<prerequisite>** - further description.
## Parameters
2017-07-11 15:12:03 +02:00
| parameter | mandatory | default | possible values |
| ---------------|-----------|-----------------------------------|--------------------|
| | | | |
* `<parameter>` - Detailed description of each parameter.
2017-07-11 15:12:03 +02:00
2018-03-06 14:43:53 +02:00
## Step configuration
2018-03-06 14:43:53 +02:00
The following parameters can also be specified as step parameters using the global configuration file:
* `<parameter>`
2017-07-11 15:12:03 +02:00
## Return value
2017-07-11 15:12:03 +02:00
none
## Side effects
2017-07-11 15:12:03 +02:00
none
## Exceptions
* `ExceptionType`
* List of cases when exception is thrown.
2017-07-11 15:12:03 +02:00
## Example
2017-07-11 15:12:03 +02:00
```groovy
```