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

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  This step clones a remote Git repository to a local repository on an ABAP server. To execute this step, the corresponding local repository must exist on the local ABAP system.
     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  gctsCloneRepository(
    22    script: this,
    23    host: 'https://abap.server.com:port',
    24    client: '000',
    25    abapCredentialsId: 'ABAPUserPasswordCredentialsId',
    26    repository: 'myrepo'
    27  )
    28  ```
    29  
    30  Example for the use in a YAML configuration file (such as `.pipeline/config.yaml`).
    31  
    32  ```yaml
    33  steps:
    34    <...>
    35    gctsCloneRepository:
    36      host: 'https://abap.server.com:port'
    37      client: '000'
    38      abapCredentialsId: 'ABAPUserPasswordCredentialsId'
    39      repository: 'myrepo'
    40  ```