mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-02-21 19:48:53 +02:00
bbf9122764
* fix(docs): fixing documentation for violating markdownlint rules. * correct indent * Apply suggestions from code review * correct list --------- Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
39 lines
575 B
Markdown
39 lines
575 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:
|
|
mtaPath: path/to/archiveFile.mtar
|
|
credentialsId: my-credentials-id
|
|
apiUrl: https://example.org/xs
|
|
space: mySpace
|
|
org: myOrg
|
|
```
|