github.com/jaylevin/jenkins-library@v1.230.4/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 Cloud Platform ABAP Environment system
    75          type: string
    76          mandatory: false
    77          scope:
    78            - PARAMETERS
    79            - STAGES
    80            - STEPS
    81            - GENERAL
    82        - name: username
    83          type: string
    84          description: User
    85          scope:
    86            - PARAMETERS
    87            - STAGES
    88            - STEPS
    89          mandatory: true
    90          secret: true
    91        - name: password
    92          type: string
    93          description: Password
    94          scope:
    95            - PARAMETERS
    96            - STAGES
    97            - STEPS
    98          mandatory: true
    99          secret: true
   100        - name: phase
   101          type: string
   102          mandatory: true
   103          description: Phase as specified in the build script in the backend system
   104          scope:
   105            - PARAMETERS
   106            - STAGES
   107            - STEPS
   108        - name: values
   109          type: string
   110          description: Input values for the build framework, please enter in the format '[{"value_id":"Id1","value":"value1"},{"value_id":"Id2","value":"value2"}]'
   111          scope:
   112            - PARAMETERS
   113            - STAGES
   114            - STEPS
   115          mandatory: false
   116        - name: downloadAllResultFiles
   117          type: bool
   118          mandatory: true
   119          default: false
   120          description: If true, all build artefacts are downloaded
   121          scope:
   122            - PARAMETERS
   123            - STAGES
   124            - STEPS
   125        - name: downloadResultFilenames
   126          type: "[]string"
   127          mandatory: false
   128          description: Only the specified files are downloaded. If downloadAllResultFiles is true, this parameter is ignored
   129          scope:
   130            - PARAMETERS
   131            - STAGES
   132            - STEPS
   133        - name: publishAllDownloadedResultFiles
   134          type: bool
   135          mandatory: true
   136          default: false
   137          description: If true, it publishes all downloaded files
   138          scope:
   139            - PARAMETERS
   140            - STAGES
   141            - STEPS
   142        - name: publishResultFilenames
   143          type: "[]string"
   144          mandatory: false
   145          description: Only the specified files get published, in case the file was not downloaded before an error occures
   146          scope:
   147            - PARAMETERS
   148            - STAGES
   149            - STEPS
   150        - name: subDirectoryForDownload
   151          type: string
   152          mandatory: false
   153          description: Target directory to store the downloaded files, {buildID} and {taskID} can be used and will be resolved accordingly
   154          scope:
   155            - PARAMETERS
   156            - STAGES
   157            - STEPS
   158            - GENERAL
   159        - name: filenamePrefixForDownload
   160          type: string
   161          mandatory: false
   162          description: Filename prefix for 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: treatWarningsAsError
   169          type: bool
   170          mandatory: true
   171          default: false
   172          description: If a warrning occures, the step will be set to unstable
   173          scope:
   174            - PARAMETERS
   175            - STAGES
   176            - STEPS
   177        - name: maxRuntimeInMinutes
   178          type: int
   179          description: maximal runtime of the step in minutes
   180          mandatory: true
   181          default: 360
   182          scope:
   183            - PARAMETERS
   184            - STAGES
   185            - STEPS
   186        - name: pollingIntervalInSeconds
   187          type: int
   188          description: wait time in seconds till next status request in the backend system
   189          mandatory: true
   190          default: 60
   191          scope:
   192            - PARAMETERS
   193            - STAGES
   194            - STEPS
   195        - name: certificateNames
   196          type: "[]string"
   197          description: certificates for the backend system, this certificates needs to be stored in .pipeline/trustStore
   198          mandatory: false
   199          scope:
   200            - PARAMETERS
   201            - STAGES
   202            - STEPS
   203            - GENERAL
   204        - name: cpeValues
   205          type: string
   206          description: Values taken from the previous step, if a value was also specified in the config file, the value from cpe will be discarded
   207          mandatory: false
   208          resourceRef:
   209            - name: commonPipelineEnvironment
   210              param: abap/buildValues
   211        - name: useFieldsOfAddonDescriptor
   212          type: string
   213          description: use fields of the addonDescriptor in the cpe as input values. Please enter in the format '[{"use":"Name","renameTo":"SWC"}]'
   214          scope:
   215            - PARAMETERS
   216            - STAGES
   217            - STEPS
   218          mandatory: false
   219        - name: conditionOnAddonDescriptor
   220          type: string
   221          description: normally if useFieldsOfAddonDescriptor is not initial, a build is triggered for each repository in the addonDescriptor. This can be changed by posing conditions.
   222                       Please enter in the format '[{"field":"Status","operator":"==","value":"P"}]'
   223          scope:
   224            - PARAMETERS
   225            - STAGES
   226            - STEPS
   227          mandatory: false
   228        - name: stopOnFirstError
   229          type: bool
   230          default: false
   231          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.
   232          scope:
   233            - PARAMETERS
   234            - STAGES
   235            - STEPS
   236        - name: addonDescriptor
   237          type: string
   238          description: Structure in the commonPipelineEnvironment containing information about the Product Version and corresponding Software Component Versions
   239          mandatory: false
   240          scope:
   241            - PARAMETERS
   242            - STAGES
   243            - STEPS
   244          resourceRef:
   245            - name: commonPipelineEnvironment
   246              param: abap/addonDescriptor
   247    outputs:
   248      resources:
   249        - name: commonPipelineEnvironment
   250          type: piperEnvironment
   251          params:
   252            - name: abap/buildValues
   253    containers:
   254      - name: cf
   255        image: ppiper/cf-cli:7