

abapAddonAssemblyKitCheckPV¶

This step checks the validity of a Addon Product Version.

Description¶

This step checks whether the Addon Product Version in the addonDescriptorFileName does exist or is a valid successor of an existing Product Version. It resolves the dotted version string into version, support package stack level and patch level and writes it to the commonPipelineEnvironment.

Usage¶

We recommend to define values of step parameters via config.yml file. In this case, calling the step is reduced to one simple line.
Calling the step can be done either via the Jenkins library step or on the command line.

Jenkins Pipeline¶

library('piper-lib-os')

abapAddonAssemblyKitCheckPV script: this

Command Line¶

piper abapAddonAssemblyKitCheckPV

Outputs¶

Output type	Details
commonPipelineEnvironment	abap/addonDescriptor

Prerequisites¶

The credentials to access the AAKaaS (e.g. S-User) must be stored in the Jenkins Credential Store
The step needs an addon.yml containing information about the Product Version and corresponding Software Component Versions/Repositories. The addon.yml should look like this:

---
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
  - name: /NAMESPC/COMPONENTA
    branch: v1.2.0
    version: 1.2.0
    commitID: 7d4516e9
  - name: /NAMESPC/COMPONENTB
    branch: v2.0.0
    version: 2.0.0
    commitID: 9f102ffb

Parameters¶

Overview¶

Name	Mandatory	Additional information
password	yes	pass via ENV or Jenkins credentials
script	yes	reference to Jenkins main pipeline script
username	yes	pass via ENV or Jenkins credentials
abapAddonAssemblyKitEndpoint	no
addonDescriptor	no
addonDescriptorFileName	no
verbose	no	activates debug output

Details¶

abapAddonAssemblyKitEndpoint¶

Base URL to the Addon Assembly Kit as a Service (AAKaaS) system

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	no
Default	`https://apps.support.sap.com`
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

addonDescriptor¶

Structure in the commonPipelineEnvironment containing information about the Product Version and corresponding Software Component Versions

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	no
Default	`$PIPER_addonDescriptor` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	commonPipelineEnvironment: reference to: `abap/addonDescriptor`

addonDescriptorFileName¶

File name of the YAML file which describes the Product Version and corresponding Software Component Versions

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	no
Default	`addon.yml`
Secret	no
Configuration scope	☐ parameter ☐ general ☐ steps ☐ stages
Resource references	none

password¶

Password for the Addon Assembly Kit as a Service (AAKaaS) system

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_password` (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☐ steps ☐ stages
Resource references	none

script¶

Jenkins-specific: Used for proper environment setup.

The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

back to overview

Scope	Details
Aliases	-
Type	`Jenkins Script`
Mandatory	yes
Default
Secret	no
Configuration scope	☐ parameter ☐ general ☐ steps ☐ stages
Resource references	none

username¶

User for the Addon Assembly Kit as a Service (AAKaaS) system

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_username` (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

verbose¶

verbose output

back to overview

Scope	Details
Aliases	-
Type	`bool`
Mandatory	no
Default	`false`
Possible values	- `true` - `false`
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

abapAddonAssemblyKitCredentialsId¶

Jenkins-specific: Used for proper environment setup. See using credentials for details.

Credential stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system

back to overview

Scope	Details
Aliases	-
Type	`string`
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages

Examples¶

Configuration in the config.yml¶

The recommended way to configure your pipeline is via the config.yml file. In this case, calling the step in the Jenkinsfile is reduced to one line:

abapAddonAssemblyKitCheckPV script: this

The config.yml should look like this:

steps:
  abapAddonAssemblyKitCheckPV:
    abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
    abapAddonAssemblyKitEndpoint: 'https://myabapAddonAssemblyKitEndpoint.com',
    addonDescriptorFileName: 'addon.yml'