mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
13d1b562bf
* adding my steps * messy step * Update abapEnvironmentAssembly.go * clean up * change yaml * corrections * Update cloudFoundryDeploy.go * update * delete simulation step * remove simulate * Update PiperGoUtils.groovy * Update PiperGoUtils.groovy * Update CommonStepsTest.groovy * add docu * Update abapEnvironmentAssembly.md * changes due to PR * Update .gitignore * b * CV list * Update abapEnvironmentAssembly.go * testing with simulation * Update abapEnvironmentAssembly.go * remove simulation * renaming * Update mkdocs.yml * moving service key to yaml and fixing code climate * Update abapEnvironmentAssemblePackages.go * Update abapEnvironmentAssemblePackages.go * Update abapEnvironmentAssemblePackages.go * Update abapEnvironmentAssemblePackages.go * change input * Update abapEnvironmentAssemblePackages.go * change json tag * fixed error handling * documentation * Update abapEnvironmentAssemblePackages.md * Update abapEnvironmentAssemblePackages.md * fixing code climate issues * fixing code climate issues * Update abapEnvironmentAssemblePackages.yaml * fixing code climate issues * Update abapEnvironmentAssemblePackages.yaml * adding unittests * adding unittests and improved logging * yaml -> json * change scope of cfServiceKeyName * correct indentation * Update CommonStepsTest.groovy * maintain correct step order * AAKaaS publishTV * AAKaaS createTV * AAKaaS createTV #2 * AAKaaS createTV #3 Co-authored-by: rosemarieB <45030247+rosemarieB@users.noreply.github.com> Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com> Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
83 lines
2.5 KiB
Markdown
83 lines
2.5 KiB
Markdown
# ${docGenStepName}
|
|
|
|
## ${docGenDescription}
|
|
|
|
## Prerequisites
|
|
|
|
* The credentials to access the AAKaaS (e.g. S-User) must be stored in the Jenkins Credential Store
|
|
* This step needs the Product Version name and the resolved version(version, spslevel and patchlevel).
|
|
* It also needs for each Software Component Version which should be part of the Target Vector, the name and the resolved version(version, splevel and patchlevel) as well as the Delivery Package.
|
|
* The Delivery Packages must exist in the package registry (status "P") or already as physical packages (status "L" or "R").
|
|
* This information is taken from the addonDescriptor in the commonPipelineEnvironment.
|
|
* If you run prior to this step the steps: [abapAddonAssemblyKitCheckCVs](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckCVs), [abapAddonAssemblyKitCheckPV](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitCheckPV) and [abapAddonAssemblyKitReserveNextPackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReserveNextPackages) you will get the needed information.
|
|
|
|
## ${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
|
|
abapAddonAssemblyKitCreateTargetVector script: this
|
|
```
|
|
|
|
The config.yml should look like this:
|
|
|
|
```yaml
|
|
steps:
|
|
abapAddonAssemblyKitCreateTargetVector:
|
|
abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
|
|
abapAddonAssemblyKitEndpoint: 'https://myabapAddonAssemblyKitEndpoint.com',
|
|
```
|
|
|
|
### Input via the CommonPipelineEnvironment
|
|
|
|
```json
|
|
{"addonProduct":"/DMO/myAddonProduct",
|
|
"addonVersion":"",
|
|
"addonVersionAAK":"0003",
|
|
"addonUniqueID":"",
|
|
"customerID":"",
|
|
"AddonSpsLevel":"0001",
|
|
"AddonPatchLevel":"0004",
|
|
"TargetVectorID":"",
|
|
"repositories":[
|
|
{
|
|
"name":"/DMO/REPO_A",
|
|
"tag":"",
|
|
"branch":"",
|
|
"version":"",
|
|
"versionAAK":"0001",
|
|
"PackageName":"SAPK001001REPOA",
|
|
"PackageType":"",
|
|
"SpLevel":"0000",
|
|
"PatchLevel":"0001",
|
|
"PredecessorCommitID":"",
|
|
"Status":"L",
|
|
"Namespace":"",
|
|
"SarXMLFilePath":""
|
|
},
|
|
{
|
|
"name":"/DMO/REPO_B",
|
|
"tag":"",
|
|
"branch":"",
|
|
"version":"",
|
|
"versionAAK":"0002",
|
|
"PackageName":"SAPK002001REPOB",
|
|
"PackageType":"",
|
|
"SpLevel":"0001",
|
|
"PatchLevel":"0001",
|
|
"PredecessorCommitID":"",
|
|
"Status":"R",
|
|
"Namespace":"",
|
|
"SarXMLFilePath":""
|
|
}
|
|
]}
|
|
```
|