github.com/jaylevin/jenkins-library@v1.230.4/template/step.md (about)

     1  # <step name>
     2  
     3  ## Description
     4  
     5  Brief description.
     6  
     7  ## Prerequisites
     8  
     9  * **<prerequisite>** - further description.
    10  
    11  ## Parameters
    12  
    13  | parameter      | mandatory | default                           | possible values    |
    14  | ---------------|-----------|-----------------------------------|--------------------|
    15  |   |   |   |   |
    16  
    17  * `<parameter>` - Detailed description of each parameter.
    18  
    19  ## Step configuration
    20  
    21  The following parameters can also be specified as step parameters using the global configuration file:
    22  
    23  * `<parameter>`
    24  
    25  ## Return value
    26  
    27  none
    28  
    29  ## Side effects
    30  
    31  none
    32  
    33  ## Exceptions
    34  
    35  * `ExceptionType`
    36    * List of cases when exception is thrown.
    37  
    38  ## Example
    39  
    40  ```groovy
    41  
    42  ```