jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity

Update addon.yml: Product X/Y SWC ABC + Short Commit ID (#2636)

Browse Source 
* 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>
This commit is contained in:
Peter Persiel 2021-02-23 11:28:37 +01:00 committed by GitHub
parent c8e9e44f23
commit e5e0a482fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 66 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/docs/pipelines/abapEnvironment/stages/build.md
View File

@ -45,14 +45,19 @@ stages:
### addon.yml
```yaml
```YAML
---
addonProduct: /DMO/PRODUCT1
addonVersion: 1.0.0
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
- name: /DMO/SWC
branch: v1.0.0
version: 1.0.0
- 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
```
### sap_com_0582.json

17
documentation/docs/pipelines/abapEnvironment/stages/integrationTest.md
View File

@ -50,12 +50,17 @@ stages:
### addon.yml
```yaml
```YAML
---
addonProduct: /DMO/PRODUCT1
addonVersion: 1.0.0
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
- name: /DMO/SWC
branch: v1.0.0
version: 1.0.0
- 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
```

17
documentation/docs/pipelines/abapEnvironment/stages/publish.md
View File

@ -31,12 +31,17 @@ stages:
### addon.yml
```yaml
```YAML
---
addonProduct: /DMO/PRODUCT1
addonVersion: 1.0.0
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
- name: /DMO/SWC
branch: v1.0.0
version: 1.0.0
- 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
```

18
documentation/docs/scenarios/abapEnvironmentAddons.md
View File

@ -29,7 +29,7 @@ The installation and maintenance of ABAP software is done / controlled via add-o
### Add-on Product Version
An add-on product version is defined by a name and a version string. The name of an add-on product is a string with a maximum of 30 characters and consists of the [namespace](https://launchpad.support.sap.com/#/notes/84282) and a freely chooseble part - `/NAMESPC/PRODUCT1`. The version string consists of three numbers separated by a dot - `1.2.0`. The numbers in the version string have a hierarchic relationship:
An add-on product version is defined by a name and a version string. The name of an add-on product is a string with a maximum of 30 characters and consists of the [namespace](https://launchpad.support.sap.com/#/notes/84282) and a freely chooseble part - `/NAMESPC/PRODUCTX`. The version string consists of three numbers separated by a dot - `1.2.0`. The numbers in the version string have a hierarchic relationship:
- The first number denotes the release. Release deliveries contain the complete scope of functionality. It is possible to change the software component version bundle in a new release.
- The second number denotes the Support Package Stack level. A Support Package stack consists of Support Package deliveries of the contained software component versions. It is not possible to change the software component version bundle in such a delivery.
@ -42,7 +42,7 @@ An add-on product version is defined by a name and a version string. The name of
### Software Component Version
A **software component version** is a technically distinguishable unit of software and is installed and patched as a whole. It consists of ABAP development packages and contained objects. Software component versions are delivered via delivery packages. But software component versions are not individual shipment entities. They can only be delivered to customers as part of an [add-on product version](#add-on-product-version).
A software component version is defined by a name and a version string. The name of a software component is string with a maximum of 30 characters and consists of the [namespace](https://launchpad.support.sap.com/#/notes/84282) and a freely chooseble part - /NAMESPC/COMPONENT1. The version consists of three numbers separated by a dot - 1.2.0. The numbers in the version string have a hierarchic relationship:
A software component version is defined by a name and a version string. The name of a software component is string with a maximum of 30 characters and consists of the [namespace](https://launchpad.support.sap.com/#/notes/84282) and a freely chooseble part - `/NAMESPC/COMPONENTA`. The version consists of three numbers separated by a dot - 1.2.0. The numbers in the version string have a hierarchic relationship:
- The first number denotes the release. Release deliveries contains the whole software component and deliver new and enhancements of existing functionalities. They are delivered with delivery packages of type [“Installation Package”](https://help.sap.com/viewer/9043aa5d2f834ad385e1cdfdadc06b6f/5.0.4.7/en-US/6082f55473568c77e10000000a174cb4.html).
- The second number denotes the Support Package level. Support Package deliveries contain a larger collection of corrections and may contains smaller functional enhancements. They are delivered with delivery packages of type [“Component Support Package”](https://help.sap.com/viewer/9043aa5d2f834ad385e1cdfdadc06b6f/5.0.4.7/en-US/6082f55473568c77e10000000a174cb4.html).
@ -153,17 +153,17 @@ The build process is controlled by an add-on descriptor file called `addon.yml`.
```YAML
---
addonProduct: /NAMESPC/PRODUCT1
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
- name: /NAMESPC/COMPONENT1
branch: release-v.1.2.0
- name: /NAMESPC/COMPONENTA
branch: v1.2.0
version: 1.2.0
commitID: 'cd87a3cac2bc946b7629580e58598c3db56a26f8'
- name: /NAMESPC/COMPONENT2
branch: release-v.2.0.0
commitID: 7d4516e9
- name: /NAMESPC/COMPONENTB
branch: v2.0.0
version: 2.0.0
commitID: '1f34b135da79dad7d498a31c15296270ff81dbd2'
commitID: 9f102ffb
```
Explanation of the keys:

23
documentation/docs/steps/abapAddonAssemblyKitCheckCVs.md
View File

@ -7,18 +7,19 @@
* 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: /DMO/myAddonProduct
addonVersion: 3.1.4
addonUniqueID: myAddonId
customerID: $ID
```YAML
---
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
- name: /DMO/REPO_A
tag: v-1.0.1-build-0001
version: 1.0.1
- name: /DMO/REPO_B
tag: rel-2.1.1-build-0001
version: 2.1.1
- 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}

23
documentation/docs/steps/abapAddonAssemblyKitCheckPV.md
View File

@ -7,18 +7,19 @@
* 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: /DMO/myAddonProduct
addonVersion: 3.1.4
addonUniqueID: myAddonId
customerID: $ID
```YAML
---
addonProduct: /NAMESPC/PRODUCTX
addonVersion: 1.2.0
repositories:
- name: /DMO/REPO_A
tag: v-1.0.1-build-0001
version: 1.0.1
- name: /DMO/REPO_B
tag: rel-2.1.1-build-0001
version: 2.1.1
- 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}