1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-04-25 12:24:42 +02:00
sap-jenkins-library/documentation/docs/steps/abapAddonAssemblyKitReserveNextPackages.md
tiloKo 7d2d9820e2
Technical Communication User (#2931)
* Technical Communication User

Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>
2021-06-21 17:56:12 +02:00

40 lines
1.6 KiB
Markdown

# ${docGenStepName}
## ${docGenDescription}
## Prerequisites
* The credentials to access the AAKaaS (Technical Communication User) must be stored in the Jenkins Credential Store
* The step needs information about the Software Component Versions for which packages should be reserved.
* This information is provided via the addonDescriptor in the commonPipelineEnvironment where the fields 'name' and 'version' in the repositories list need to be filled.
* The Software Component Versions must be valid.
* The validation is performed and the required information is written to the CommonPipelineEnvironment if you run prior to this step the step [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs)
A detailed description of all prerequisites of the scenario and how to configure them can be found in the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).
## ${docGenParameters}
## ${docGenConfiguration}
## ${docJenkinsPluginDependencies}
## 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:
```groovy
abapAddonAssemblyKitReserveNextPackages script: this
```
If the step is to be configured individually the config.yml should look like this:
```yaml
steps:
abapAddonAssemblyKitReserveNextPackages:
abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId'
```
More convenient ways of configuration (e.g. on stage level) are described in the respective scenario/pipeline documentation.