1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-09-16 09:26:22 +02:00

Template overhaul

Step template improvements.
Addition of script template.
This commit is contained in:
Oliver Feldmann
2017-11-27 11:28:26 +01:00
parent 8e70c72ea9
commit b4a4f135fa
2 changed files with 54 additions and 8 deletions

50
template/script.md Normal file
View File

@@ -0,0 +1,50 @@
# <script name>
## Description
Brief description.
## Constructors
### <script name>(<arguments>)
#### Parameters
| parameter | mandatory | default | possible values |
| ---------------|-----------|-----------------------------------|--------------------|
| | | | |
* `<parameter>` - Detailed description of each parameter.
#### Exceptions
* `ExceptionType`
* List of cases when exception is thrown.
#### Example
```groovy
```
## Method Details
### <method>(<arguments>)
#### Description
Brief description.
#### Parameters
* `<parameter>` - Detailed description of each parameter.
#### Return value
none
#### Side effects
none
#### Exceptions
* `ExceptionType`
* List of cases when exception is thrown.
#### Example
```groovy
```

View File

@@ -1,31 +1,27 @@
# <step name>
## Description
Brief description.
## Prerequisites
* **<prerequisite>** - further description.
## Parameters
| parameter | mandatory | default | possible values |
| ---------------|-----------|-----------------------------------|--------------------|
| | | | |
* detailed description of each parameter.
* `<parameter>` - Detailed description of each parameter.
## Return value
none
## Side effects
none
## Exceptions
none
* `ExceptionType`
* List of cases when exception is thrown.
## Example
```groovy