sap-jenkins-library/resources/metadata/gctsDeploy.yaml

metadata:
  name: gctsDeploy
  description: Deploys a Git Repository to a local Repository and then to an ABAP System
  longDescription: |
    This step deploys a remote Git repository to a local repository on an ABAP system and imports the content in the ABAP database.
    If the repository does not yet exist in the system, this step also creates it.
    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.
    These actions include, for example, deploy a specific commit to the ABAP system, or deploy the current commit of a specific branch.
    You can use this step for gCTS as of SAP S/4HANA 2020.    

spec:
  inputs:
    secrets:
      - name: abapCredentialsId
        description: ID taken from the Jenkins credentials store containing the user name and password of the user that authenticates to the ABAP system.
        type: jenkins
    params:
      - name: username
        type: string
        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.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
        secret: true
        resourceRef:
          - name: abapCredentialsId
            type: secret
            param: username
      - name: password
        type: string
        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.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
        secret: true
        resourceRef:
          - name: abapCredentialsId
            type: secret
            param: password
      - name: repository
        type: string
        description: Specifies the name (ID) of the local repsitory on the ABAP system
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
      - name: host
        type: string
        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`.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
      - name: client
        type: string
        description: Client of the ABAP system to which you want to deploy the repository
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
      - name: commit
        type: string
        description: ID of a specific commit, if you want to deploy the content of the specified commit.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
      - name: remoteRepositoryURL
        type: string
        description: URL of the remote repository
        mandatory: true
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
      - name: role
        type: string
        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.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        possibleValues:
          - SOURCE
          - TARGET
        default: SOURCE
      - name: vSID
        type: string
        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/docs/ABAP_PLATFORM_NEW/4a368c163b08418890a406d413933ba7/8edc17edfc374908bd8a1615ea5ab7b7.html) on SAP Help Portal.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
      - name: type
        type: string
        description: Type of the used source code management tool
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        default: GIT
        possibleValues:
          - GIT
          - GITHUB
          - GITLAB
      - name: branch
        type: string
        description: Name of a branch, if you want to deploy the content of a specific branch to the ABAP system.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
      - name: scope
        type: string
        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.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
      - name: rollback
        type: bool
        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.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
      - name: configuration
        type: "map[string]interface{}"
        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/docs/ABAP_PLATFORM_NEW/4a368c163b08418890a406d413933ba7/99e471efcbee4a0faec82f9dd15897e1.html)."
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
          - GENERAL
        mandatory: false
        aliases:
          - name: gctsRepositoryConfigurations
      - name: queryParameters
        type: "map[string]interface{}"
        description: Add query parameters (for API requests) that apply to all endpoints of the step. Provide the parameters as key-value pair map in the format `<query parameter>:<value>`.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: false
      - name: skipSSLVerification
        type: bool
        description: Skip the verification of SSL (Secure Socket Layer) certificates when using HTTPS. This parameter is **not recommended** for productive environments.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: false
        default: false