2019-04-01 15:08:37 +02:00
|
|
|
# ${docGenStepName}
|
2017-11-24 15:49:20 +02:00
|
|
|
|
2019-04-01 15:08:37 +02:00
|
|
|
## ${docGenDescription}
|
2017-12-01 16:34:25 +02:00
|
|
|
|
2017-11-24 15:49:20 +02:00
|
|
|
## Prerequisites
|
|
|
|
|
|
|
|
|
|
none
|
|
|
|
|
|
2019-04-01 15:08:37 +02:00
|
|
|
## ${docGenParameters}
|
2017-11-24 15:49:20 +02:00
|
|
|
|
2019-04-01 15:08:37 +02:00
|
|
|
## ${docGenConfiguration}
|
2018-03-06 14:43:53 +02:00
|
|
|
|
2019-05-24 15:44:31 +02:00
|
|
|
## ${docJenkinsPluginDependencies}
|
2019-05-24 15:41:49 +02:00
|
|
|
|
2017-11-24 15:49:20 +02:00
|
|
|
## Side effects
|
|
|
|
|
|
2017-11-28 10:34:54 +02:00
|
|
|
none
|
2017-11-24 15:49:20 +02:00
|
|
|
|
|
|
|
|
## Exceptions
|
|
|
|
|
|
|
|
|
|
* `Exception`
|
2018-11-06 14:50:09 +02:00
|
|
|
* If `repoUrl` is not provided.
|
2017-11-24 15:49:20 +02:00
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
```groovy
|
2017-12-01 11:51:11 +02:00
|
|
|
pipelineExecute repoUrl: "https://github.com/MyOrg/MyPipelineRepo.git", branch: 'feature1', path: 'path/to/Jenkinsfile', credentialsId: 'MY_REPO_CREDENTIALS'
|
2017-11-24 15:49:20 +02:00
|
|
|
```
|
