github.com/xgoffin/jenkins-library@v1.154.0/documentation/docs/steps/pipelineRestartSteps.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  none
     8  
     9  ## ${docGenParameters}
    10  
    11  ## ${docGenConfiguration}
    12  
    13  ## Example
    14  
    15  Usage of pipeline step:
    16  
    17  ```groovy
    18  pipelineRestartSteps (script: this) {
    19    node {
    20      //your steps ...
    21    }
    22  }
    23  ```
    24  
    25  !!! caution
    26      Use `node` inside the step. If a `node` exists outside the step context, the `input` step which is triggered in the process will block a Jenkins executor.
    27  
    28      In case you cannot use `node` inside this step, please choose the parameter `timeoutInSeconds` carefully!
    29  
    30  ## Side effects
    31  
    32  none
    33  
    34  ## ${docJenkinsPluginDependencies}
    35  
    36  ## Exceptions
    37  
    38  none