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

     1  metadata:
     2    name: gctsRollback
     3    description: Perfoms a rollback of one (default) or several commits
     4    longDescription: |
     5      This step performs a rollback of commits in a local ABAP repository. If a `commit` parameter is specified, it will be used as the target commit for the rollback.
     6      If no `commit` parameter is specified and the remote repository domain is 'github.com', the last commit with the status 'success' will be used for the rollback. Otherwise,
     7      `gctsRollback` will roll back to the previously active commit in the local repository.
     8  
     9  spec:
    10    inputs:
    11      secrets:
    12        - name: abapCredentialsId
    13          description: ID taken from the Jenkins credentials store containing user name and password of the user that authenticates to the ABAP system on which you want to execute the rollback.
    14          type: jenkins
    15        - name: githubPersonalAccessTokenId
    16          description: GitHub personal access token with at least read permissions for the remote repository
    17          type: jenkins
    18      params:
    19        - name: username
    20          type: string
    21          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.
    22          scope:
    23            - PARAMETERS
    24            - STAGES
    25            - STEPS
    26          mandatory: true
    27          secret: true
    28          resourceRef:
    29            - name: abapCredentialsId
    30              type: secret
    31              param: username
    32        - name: password
    33          type: string
    34          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.
    35          scope:
    36            - PARAMETERS
    37            - STAGES
    38            - STEPS
    39          mandatory: true
    40          secret: true
    41          resourceRef:
    42            - name: abapCredentialsId
    43              type: secret
    44              param: password
    45        - name: repository
    46          type: string
    47          description: Specifies the name (ID) of the local repsitory on the ABAP system
    48          scope:
    49            - PARAMETERS
    50            - STAGES
    51            - STEPS
    52          mandatory: true
    53        - name: host
    54          type: string
    55          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`.
    56          scope:
    57            - PARAMETERS
    58            - STAGES
    59            - STEPS
    60          mandatory: true
    61        - name: client
    62          type: string
    63          description: Specifies the client of the ABAP system to be addressed
    64          scope:
    65            - PARAMETERS
    66            - STAGES
    67            - STEPS
    68          mandatory: true
    69        - name: commit
    70          type: string
    71          description: Specifies the target commit for the rollback
    72          scope:
    73            - PARAMETERS
    74            - STAGES
    75            - STEPS
    76        - name: githubPersonalAccessToken
    77          type: string
    78          description: GitHub personal access token with at least read permissions for the remote repository
    79          scope:
    80            - PARAMETERS
    81            - STAGES
    82            - STEPS
    83          secret: true
    84          resourceRef:
    85            - name: githubPersonalAccessTokenId
    86              type: secret