github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/documentation/docs/steps/gctsDeploy.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  If you provide a `commit ID`, the step deploys the content of the specified commit to the ABAP system. If you provide a `branch`, the step deploys the content of the specified branch. If you set the `rollback` parameter to *true*, the step returns to a working state of the repository, if the deployment of the specified commit or branch fails.
     8  More information about the [Git-enabled Change and Transport System (gCTS)](https://help.sap.com/docs/ABAP_PLATFORM_NEW/4a368c163b08418890a406d413933ba7/f319b168e87e42149e25e13c08d002b9.html).
     9  
    10  ## ${docGenParameters}
    11  
    12  ## ${docGenConfiguration}
    13  
    14  ## ${docJenkinsPluginDependencies}
    15  
    16  ## Example
    17  
    18  Example configuration for the use in a `Jenkinsfile`.
    19  
    20  ```groovy
    21  gctsDeploy(
    22    script: this,
    23    host: 'https://abap.server.com:port',
    24    client: '000',
    25    abapCredentialsId: 'ABAPUserPasswordCredentialsId',
    26    repository: 'myrepo',
    27    remoteRepositoryURL: "https://remote.repository.url.com",
    28    role: 'SOURCE',
    29    vSID: 'ABC',
    30    branch: 'feature1',
    31    commit: '95952ec',
    32    scope: 'LASTACTION',
    33    rollback: true,
    34    configuration: [VCS_AUTOMATIC_PULL: 'FALSE',VCS_AUTOMATIC_PUSH: 'FALSE',CLIENT_VCS_LOGLVL: 'debug'],
    35    queryparameters: [saml2: 'disabled']
    36  )
    37  ```
    38  
    39  Example for the use in a YAML configuration file (such as `.pipeline/config.yaml`).
    40  
    41  ```yaml
    42  steps:
    43    <...>
    44    gctsDeploy:
    45      host: 'https://abap.server.com:port'
    46      client: '000'
    47      abapCredentialsId: 'ABAPUserPasswordCredentialsId'
    48      repository: 'myrepo'
    49      remoteRepositoryURL: "https://remote.repository.url.com"
    50      role: 'SOURCE'
    51      vSID: 'ABC'
    52      branch: 'feature2'
    53      commit: '0c9d330'
    54      scope: 'CRNTCOMMIT'
    55      rollback: false
    56      configuration:
    57          VCS_AUTOMATIC_PULL: "FALSE"
    58          VCS_AUTOMATIC_PUSH: "FALSE"
    59          CLIENT_VCS_LOGLVL: "debug"
    60      queryparameters:
    61          saml2: "disabled"
    62  ```