github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/gctsDeploy.yaml (about)

     1  metadata:
     2    name: gctsDeploy
     3    description: Deploys a Git Repository to a local Repository and then to an ABAP System
     4    longDescription: |
     5      This step deploys a remote Git repository to a local repository on an ABAP system and imports the content in the ABAP database.
     6      If the repository does not yet exist in the system, this step also creates it.
     7      If the repository already exists on the ABAP system, this step executes the remaining actions of the step, depending on the parameters provided for the step.
     8      These actions include, for example, deploy a specific commit to the ABAP system, or deploy the current commit of a specific branch.
     9      You can use this step for gCTS as of SAP S/4HANA 2020.
    10  
    11  spec:
    12    inputs:
    13      secrets:
    14        - name: abapCredentialsId
    15          description: ID taken from the Jenkins credentials store containing the user name and password of the user that authenticates to the ABAP system.
    16          type: jenkins
    17      params:
    18        - name: username
    19          type: string
    20          description: User that authenticates to the ABAP system. **Note** - Don't provide this parameter directly. Either set it in the environment, or in the Jenkins credentials store, and provide the ID as value of the `abapCredentialsId` parameter.
    21          scope:
    22            - PARAMETERS
    23            - STAGES
    24            - STEPS
    25          mandatory: true
    26          secret: true
    27          resourceRef:
    28            - name: abapCredentialsId
    29              type: secret
    30              param: username
    31        - name: password
    32          type: string
    33          description: Password of the ABAP user that authenticates to the ABAP system. **Note** - Don´t provide this parameter directly. Either set it in the environment, or in the Jenkins credentials store, and provide the ID as value of the `abapCredentialsId` parameter.
    34          scope:
    35            - PARAMETERS
    36            - STAGES
    37            - STEPS
    38          mandatory: true
    39          secret: true
    40          resourceRef:
    41            - name: abapCredentialsId
    42              type: secret
    43              param: password
    44        - name: repository
    45          type: string
    46          description: Specifies the name (ID) of the local repsitory on the ABAP system
    47          scope:
    48            - PARAMETERS
    49            - STAGES
    50            - STEPS
    51          mandatory: true
    52        - name: host
    53          type: string
    54          description: Protocol and host of the ABAP system, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.
    55          scope:
    56            - PARAMETERS
    57            - STAGES
    58            - STEPS
    59          mandatory: true
    60        - name: client
    61          type: string
    62          description: Client of the ABAP system to which you want to deploy the repository
    63          scope:
    64            - PARAMETERS
    65            - STAGES
    66            - STEPS
    67          mandatory: true
    68        - name: commit
    69          type: string
    70          description: ID of a specific commit, if you want to deploy the content of the specified commit.
    71          scope:
    72            - PARAMETERS
    73            - STAGES
    74            - STEPS
    75        - name: remoteRepositoryURL
    76          type: string
    77          description: URL of the remote repository
    78          mandatory: true
    79          scope:
    80            - PARAMETERS
    81            - STAGES
    82            - STEPS
    83        - name: role
    84          type: string
    85          description: Role of the local repository. Possible values are 'SOURCE' (for repositories on development systems - Default) and 'TARGET' (for repositories on target systems). Local repositories with a TARGET role cannot be the source of code changes.
    86          scope:
    87            - PARAMETERS
    88            - STAGES
    89            - STEPS
    90          possibleValues:
    91            - SOURCE
    92            - TARGET
    93          default: SOURCE
    94        - name: vSID
    95          type: string
    96          description: Virtual SID of the local repository. The vSID corresponds to the transport route that delivers content to the remote Git repository. For more information, see [Background Information - vSID](https://help.sap.com/viewer/4a368c163b08418890a406d413933ba7/latest/en-US/8edc17edfc374908bd8a1615ea5ab7b7.html) on SAP Help Portal.
    97          scope:
    98            - PARAMETERS
    99            - STAGES
   100            - STEPS
   101        - name: type
   102          type: string
   103          description: Type of the used source code management tool
   104          scope:
   105            - PARAMETERS
   106            - STAGES
   107            - STEPS
   108          default: GIT
   109          possibleValues:
   110            - GIT
   111            - GITHUB
   112            - GITLAB
   113        - name: branch
   114          type: string
   115          description: Name of a branch, if you want to deploy the content of a specific branch to the ABAP system.
   116          scope:
   117            - PARAMETERS
   118            - STAGES
   119            - STEPS
   120        - name: scope
   121          type: string
   122          description: Scope of objects to be deployed. Possible values are CRNTCOMMIT (current commit - Default) and LASTACTION (last repository action). The default option deploys all objects that existed in the repository when the commit was created. LASTACTION only deploys the object difference of the last action in the repository.
   123          scope:
   124            - PARAMETERS
   125            - STAGES
   126            - STEPS
   127        - name: rollback
   128          type: bool
   129          description: Indication whether you want to roll back to the last working state of the repository, if any of the step actions *switch branch* or *pull commit* fail.
   130          scope:
   131            - PARAMETERS
   132            - STAGES
   133            - STEPS
   134        - name: configuration
   135          type: "map[string]interface{}"
   136          description: "Configuration parameters for the repository. Provide the parameters as a key-value pair map in the following format: `<configuration parameter>`:`<Value>`. For a list of available configuration parameters, see [Configuration Parameters for Repositories](https://help.sap.com/viewer/4a368c163b08418890a406d413933ba7/latest/en-US/99e471efcbee4a0faec82f9dd15897e1.html)."
   137          scope:
   138            - PARAMETERS
   139            - STAGES
   140            - STEPS
   141            - GENERAL
   142          mandatory: false
   143          aliases:
   144            - name: gctsRepositoryConfigurations