abapAddonAssemblyKitReleasePackages¶

This step releases the physical Delivery Packages

Description¶

This step takes the list of Software Component Versions from the addonDescriptor in the commonPipelineEnvironment. The physical Delivery Packages in status “L” are released. The new status "R"eleased is written back to the addonDescriptor in the commonPipelineEnvironment.
For Terminology refer to the Scenario Description.

Usage¶

We recommend to define values of step parameters via .pipeline/config.yml file.
In this case, calling the step is essentially reduced to defining the step name.
Calling the step can be done either in an orchestrator specific way (e.g. via a Jenkins library step) or on the command line.

JenkinsCommand Line

library('piper-lib-os')

abapAddonAssemblyKitReleasePackages script: this

piper abapAddonAssemblyKitReleasePackages

Outputs¶

Output type	Details
commonPipelineEnvironment	abap/addonDescriptor

Prerequisites¶

The credentials to access the AAKaaS (Technical Communication User) must be stored in the Jenkins Credential Store
This step needs the names of the packages which should be released. The packages needs to be in status "L"ocked. If they are already in status "R"eleased it is fine, then the release will just not be executed. However this step will end with an error if a package has status "P"lanned.
The package names are taken from the addonDescriptor in the commonPipelineEnvironment together with the status of the packages.
The step abapAddonAssemblyKitRegisterPackages will set the status of the packages to "L"ocked and writes the needed data to the commonPipelineEnvironment.

A detailed description of all prerequisites of the scenario and how to configure them can be found in the Scenario Description.

Parameters¶

Overview - Step¶

Name	Mandatory	Additional information
addonDescriptor	yes
password	yes
script	(yes)	reference to Jenkins main pipeline script
username	yes
abapAddonAssemblyKitEndpoint	no
maxRuntimeInMinutes	no
pollingIntervalInSeconds	no
verbose	no	activates debug output

Overview - Execution Environment¶

Orchestrator-specific only

These parameters are relevant for orchestrator usage and not considered when using the command line option.

Name	Mandatory	Additional information

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	yes
Default	`$PIPER_addonDescriptor` (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	commonPipelineEnvironment: reference to: `abap/addonDescriptor`

maxRuntimeInMinutes¶

Maximum runtime for status polling in minutes

back to overview

Scope	Details
Aliases	-
Type	`int`
Mandatory	no
Default	`5`
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	no
Configuration scope	☒ parameter ☐ general ☐ steps ☐ stages
Resource references	none

pollingIntervalInSeconds¶

Wait time in seconds between polling calls

back to overview

Scope	Details
Aliases	-
Type	`int`
Mandatory	no
Default	`30`
Secret	no
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	no
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:

abapAddonAssemblyKitReleasePackages script: this

If the step is to be configured individually the config.yml should look like this:

steps:
  abapAddonAssemblyKitReleasePackages:
    abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId'

More convenient ways of configuration (e.g. on stage level) are described in the respective scenario/pipeline documentation.