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

     1  metadata:
     2    name: isChangeInDevelopment
     3    description: This step checks if a certain change is in status 'in development'
     4    longDescription: |
     5      This step checks if a certain change is in status 'in development'
     6  
     7  spec:
     8    inputs:
     9      secrets:
    10        - name: credentialsId
    11          description: Jenkins 'Username with password' credentials ID containing user and password to authenticate against the ABAP backend
    12          type: jenkins
    13          aliases:
    14            - name: changeManagement/credentialsId
    15      params:
    16        - name: endpoint
    17          type: string
    18          mandatory: true
    19          description: "The service endpoint"
    20          aliases:
    21            - name: changeManagement/endpoint
    22          scope:
    23            - PARAMETERS
    24            - STAGES
    25            - STEPS
    26            - GENERAL
    27        - name: username
    28          type: string
    29          mandatory: true
    30          description: "Service user to authenticate against the ABAP backend"
    31          secret: true
    32          scope:
    33            - PARAMETERS
    34            - STAGES
    35            - STEPS
    36            - GENERAL
    37          resourceRef:
    38            - name: credentialsId
    39              type: secret
    40              param: username
    41        - name: password
    42          type: string
    43          mandatory: true
    44          description: "Service user password to authenticate against the ABAP backend"
    45          secret: true
    46          scope:
    47            - PARAMETERS
    48          resourceRef:
    49            - name: credentialsId
    50              type: secret
    51              param: password
    52        - name: changeDocumentId
    53          resourceRef:
    54            - name: commonPipelineEnvironment
    55              param: custom/changeDocumentId
    56          type: string
    57          mandatory: true
    58          description: "ID of the change document to be checked for the status"
    59          scope:
    60            - PARAMETERS
    61        - name: failIfStatusIsNotInDevelopment
    62          type: bool
    63          default: true
    64          description: "lets the build fail in case the change is not in status 'in developent'. Otherwise a warning is emitted to the log"
    65          scope:
    66            - PARAMETERS
    67            - STAGES
    68            - STEPS
    69        - name: cmClientOpts
    70          type: "[]string"
    71          description: "additional options passed to cm client, e.g. for troubleshooting"
    72          scope:
    73            - PARAMETERS
    74            - STAGES
    75            - STEPS
    76          aliases:
    77            - name: clientOpts
    78            - name: changeManagement/clientOpts
    79    outputs:
    80      resources:
    81        - name: commonPipelineEnvironment
    82          type: piperEnvironment
    83          params:
    84            - name: custom/isChangeInDevelopment
    85              type: bool
    86    containers:
    87      - name: cmclient
    88        image: ppiper/cm-client:3.0.0.0