You've already forked sap-jenkins-library
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:
50
template/script.md
Normal file
50
template/script.md
Normal 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
|
||||
|
||||
```
|
@@ -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
|
||||
|
Reference in New Issue
Block a user