github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/resources/metadata/abapEnvironmentBuild.yaml (about)

     1  metadata:
     2    name: abapEnvironmentBuild
     3    description: "Executes builds as defined with the build framework"
     4    longDescription: |
     5      Executes builds as defined with the build framework. Transaction overview /n/BUILD/OVERVIEW
     6  spec:
     7    inputs:
     8      secrets:
     9        - name: abapCredentialsId
    10          description: Jenkins credentials ID containing user and password to authenticate to the Cloud Platform ABAP Environment system or the Cloud Foundry API
    11          type: jenkins
    12          aliases:
    13            - name: cfCredentialsId
    14            - name: credentialsId
    15      params:
    16        - name: cfApiEndpoint
    17          type: string
    18          description: Cloud Foundry API endpoint
    19          scope:
    20            - PARAMETERS
    21            - STAGES
    22            - STEPS
    23            - GENERAL
    24          mandatory: false
    25          aliases:
    26            - name: cloudFoundry/apiEndpoint
    27        - name: cfOrg
    28          type: string
    29          description: Cloud Foundry target organization
    30          scope:
    31            - PARAMETERS
    32            - STAGES
    33            - STEPS
    34            - GENERAL
    35          mandatory: false
    36          aliases:
    37            - name: cloudFoundry/org
    38        - name: cfSpace
    39          type: string
    40          description: Cloud Foundry target space
    41          scope:
    42            - PARAMETERS
    43            - STAGES
    44            - STEPS
    45            - GENERAL
    46          mandatory: false
    47          aliases:
    48            - name: cloudFoundry/space
    49        - name: cfServiceInstance
    50          type: string
    51          description: Cloud Foundry Service Instance
    52          scope:
    53            - PARAMETERS
    54            - STAGES
    55            - STEPS
    56            - GENERAL
    57          mandatory: false
    58          aliases:
    59            - name: cloudFoundry/serviceInstance
    60        - name: cfServiceKeyName
    61          type: string
    62          description: Cloud Foundry Service Key
    63          scope:
    64            - PARAMETERS
    65            - STAGES
    66            - STEPS
    67            - GENERAL
    68          mandatory: false
    69          aliases:
    70            - name: cloudFoundry/serviceKey
    71            - name: cloudFoundry/serviceKeyName
    72            - name: cfServiceKey
    73        - name: host
    74          description: Specifies the host address of the SAP BTP ABAP Environment system
    75          type: string
    76          mandatory: false
    77          scope:
    78            - PARAMETERS
    79            - STAGES
    80            - STEPS
    81            - GENERAL
    82        - name: abapSourceClient
    83          description: Specifies the client of the SAP BTP ABAP Environment system, use only in combination with host
    84          type: string
    85          mandatory: false
    86          scope:
    87            - PARAMETERS
    88            - STAGES
    89            - STEPS
    90            - GENERAL
    91        - name: username
    92          type: string
    93          description: User
    94          scope:
    95            - PARAMETERS
    96            - STAGES
    97            - STEPS
    98          mandatory: true
    99          secret: true
   100        - name: password
   101          type: string
   102          description: Password
   103          scope:
   104            - PARAMETERS
   105            - STAGES
   106            - STEPS
   107          mandatory: true
   108          secret: true
   109        - name: phase
   110          type: string
   111          mandatory: true
   112          description: Phase as specified in the build script in the backend system
   113          scope:
   114            - PARAMETERS
   115            - STAGES
   116            - STEPS
   117        - name: values
   118          type: string
   119          description: Input values for the build framework, please enter in the format '[{"value_id":"Id1","value":"value1"},{"value_id":"Id2","value":"value2"}]'
   120          scope:
   121            - PARAMETERS
   122            - STAGES
   123            - STEPS
   124          mandatory: false
   125        - name: downloadAllResultFiles
   126          type: bool
   127          mandatory: true
   128          default: false
   129          description: If true, all build artefacts are downloaded
   130          scope:
   131            - PARAMETERS
   132            - STAGES
   133            - STEPS
   134        - name: downloadResultFilenames
   135          type: "[]string"
   136          mandatory: false
   137          description: Only the specified files are downloaded. If downloadAllResultFiles is true, this parameter is ignored
   138          scope:
   139            - PARAMETERS
   140            - STAGES
   141            - STEPS
   142        - name: publishAllDownloadedResultFiles
   143          type: bool
   144          mandatory: true
   145          default: false
   146          description: If true, it publishes all downloaded files
   147          scope:
   148            - PARAMETERS
   149            - STAGES
   150            - STEPS
   151        - name: publishResultFilenames
   152          type: "[]string"
   153          mandatory: false
   154          description: Only the specified files get published, in case the file was not downloaded before an error occures
   155          scope:
   156            - PARAMETERS
   157            - STAGES
   158            - STEPS
   159        - name: subDirectoryForDownload
   160          type: string
   161          mandatory: false
   162          description: Target directory to store the downloaded files, {buildID} and {taskID} can be used and will be resolved accordingly
   163          scope:
   164            - PARAMETERS
   165            - STAGES
   166            - STEPS
   167            - GENERAL
   168        - name: filenamePrefixForDownload
   169          type: string
   170          mandatory: false
   171          description: Filename prefix for the downloaded files, {buildID} and {taskID} can be used and will be resolved accordingly
   172          scope:
   173            - PARAMETERS
   174            - STAGES
   175            - STEPS
   176            - GENERAL
   177        - name: treatWarningsAsError
   178          type: bool
   179          mandatory: true
   180          default: false
   181          description: If a warrning occures, the step will be set to unstable
   182          scope:
   183            - PARAMETERS
   184            - STAGES
   185            - STEPS
   186        - name: maxRuntimeInMinutes
   187          type: int
   188          description: maximal runtime of the step in minutes
   189          mandatory: true
   190          default: 360
   191          scope:
   192            - PARAMETERS
   193            - STAGES
   194            - STEPS
   195        - name: pollingIntervalInSeconds
   196          type: int
   197          description: wait time in seconds till next status request in the backend system
   198          mandatory: true
   199          default: 60
   200          scope:
   201            - PARAMETERS
   202            - STAGES
   203            - STEPS
   204        - name: certificateNames
   205          type: "[]string"
   206          description: certificates for the backend system, this certificates needs to be stored in .pipeline/trustStore
   207          mandatory: false
   208          scope:
   209            - PARAMETERS
   210            - STAGES
   211            - STEPS
   212            - GENERAL
   213        - name: cpeValues
   214          type: string
   215          description: Values taken from the previous step, if a value was also specified in the config file, the value from cpe will be discarded
   216          mandatory: false
   217          resourceRef:
   218            - name: commonPipelineEnvironment
   219              param: abap/buildValues
   220        - name: useFieldsOfAddonDescriptor
   221          type: string
   222          description: use fields of the addonDescriptor in the cpe as input values. Please enter in the format '[{"use":"Name","renameTo":"SWC"}]'
   223          scope:
   224            - PARAMETERS
   225            - STAGES
   226            - STEPS
   227          mandatory: false
   228        - name: conditionOnAddonDescriptor
   229          type: string
   230          description: normally if useFieldsOfAddonDescriptor is not initial, a build is triggered for each repository in the addonDescriptor. This can be changed by posing conditions.
   231                       Please enter in the format '[{"field":"Status","operator":"==","value":"P"}]'
   232          scope:
   233            - PARAMETERS
   234            - STAGES
   235            - STEPS
   236          mandatory: false
   237        - name: stopOnFirstError
   238          type: bool
   239          default: false
   240          description: If false, it does not stop if an error occured for one repository in the addonDescriptor, but continues with the next repository. However the step is marked as failed in the end if an error occured.
   241          scope:
   242            - PARAMETERS
   243            - STAGES
   244            - STEPS
   245        - name: addonDescriptor
   246          type: string
   247          description: Structure in the commonPipelineEnvironment containing information about the Product Version and corresponding Software Component Versions
   248          mandatory: false
   249          scope:
   250            - PARAMETERS
   251            - STAGES
   252            - STEPS
   253          resourceRef:
   254            - name: commonPipelineEnvironment
   255              param: abap/addonDescriptor
   256    outputs:
   257      resources:
   258        - name: commonPipelineEnvironment
   259          type: piperEnvironment
   260          params:
   261            - name: abap/buildValues
   262    containers:
   263      - name: cf
   264        image: ppiper/cf-cli:v12