github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/xsDeploy.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## ${docGenParameters}
     6  
     7  ## ${docGenConfiguration}
     8  
     9  ## ${docJenkinsPluginDependencies}
    10  
    11  ## Side effects
    12  
    13  none
    14  
    15  ## Example
    16  
    17  ```groovy
    18  xsDeploy
    19      script: this,
    20      mtaPath: 'path/to/archiveFile.mtar',
    21      credentialsId: 'my-credentials-id',
    22      apiUrl: 'https://example.org/xs',
    23      space: 'mySpace',
    24      org: 'myOrg'
    25  ```
    26  
    27  Example configuration:
    28  
    29  ```yaml
    30  steps:
    31    <...>
    32    xsDeploy:
    33      mtaPath: path/to/archiveFile.mtar
    34      credentialsId: my-credentials-id
    35      apiUrl: https://example.org/xs
    36      space: mySpace
    37      org: myOrg
    38  ```
    39  
    40  [dockerExecute]: ../dockerExecute