mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-25 12:24:42 +02:00
e5e0a482fa
* Update addon.yml: Product X/Y SWC ABC + Short Commit ID * Update build.md * Update integrationTest.md * Update publish.md * Update abapAddonAssemblyKitCheckCVs.md * Update abapAddonAssemblyKitCheckPV.md * Update integrationTest.md * Update abapEnvironmentAddons.md Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# ${docGenStepName}
|
|
|
|
## ${docGenDescription}
|
|
|
|
## 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:
|
|
|
|
```YAML
|
|
---
|
|
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
|
|
```
|
|
|
|
## ${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
|
|
abapAddonAssemblyKitCheckPV script: this
|
|
```
|
|
|
|
The config.yml should look like this:
|
|
|
|
```yaml
|
|
steps:
|
|
abapAddonAssemblyKitCheckPV:
|
|
abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
|
|
abapAddonAssemblyKitEndpoint: 'https://myabapAddonAssemblyKitEndpoint.com',
|
|
addonDescriptorFileName: 'addon.yml'
|
|
```
|