mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-16 11:09:33 +02:00
42 lines
630 B
Markdown
42 lines
630 B
Markdown
|
# ${docGenStepName}
|
||
|
|
|
||
|
|
## ${docGenDescription}
|
||
|
|
|
||
|
|
## ${docGenParameters}
|
||
|
|
|
||
|
|
## ${docGenConfiguration}
|
||
|
|
|
||
|
|
## ${docJenkinsPluginDependencies}
|
||
|
|
|
||
|
|
## Side effects
|
||
|
|
|
||
|
|
none
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```groovy
|
||
|
|
xsDeploy
|
||
|
|
script: this,
|
||
|
|
mtaPath: 'path/to/archiveFile.mtar',
|
||
|
|
credentialsId: 'my-credentials-id',
|
||
|
|
apiUrl: 'https://example.org/xs',
|
||
|
|
space: 'mySpace',
|
||
|
|
org:: 'myOrg'
|
||
|
|
```
|
||
|
|
|
||
|
|
Example configuration:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
steps:
|
||
|
|
<...>
|
||
|
|
xsDeploy:
|
||
|
|
script: this,
|
||
|
|
mtaPath: path/to/archiveFile.mtar
|
||
|
|
credentialsId: my-credentials-id
|
||
|
|
apiUrl: https://example.org/xs
|
||
|
|
space: mySpace
|
||
|
|
org:: myOrg
|
||
|
|
```
|
||
|
|
|
||
|
|
[dockerExecute]: ../dockerExecute
|