mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-01-30 05:59:39 +02:00
35 lines
672 B
Markdown
35 lines
672 B
Markdown
# <step name>
|
|
|
|
## Description
|
|
Brief description.
|
|
|
|
## Prerequisites
|
|
* **<prerequisite>** - further description.
|
|
|
|
## Parameters
|
|
| parameter | mandatory | default | possible values |
|
|
| ---------------|-----------|-----------------------------------|--------------------|
|
|
| | | | |
|
|
|
|
* `<parameter>` - Detailed description of each parameter.
|
|
|
|
## Step configuration
|
|
The following parameters can also be specified as step parameters using the global configuration file:
|
|
|
|
* `<parameter>`
|
|
|
|
## Return value
|
|
none
|
|
|
|
## Side effects
|
|
none
|
|
|
|
## Exceptions
|
|
* `ExceptionType`
|
|
* List of cases when exception is thrown.
|
|
|
|
## Example
|
|
```groovy
|
|
|
|
```
|