mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-23 12:19:04 +02:00
fa17611a59
* 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 register package * AAKaaS register package #2 * Update documentation/docs/steps/abapAddonAssemblyKitPublishTargetVector.md Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com> * AAKaaS register package #3 * AAKaaS release package * Update abapAddonAssemblyKitReleasePackages.go * AAKaas release package #2 * AAKaaS reserve * AAKaaS reserve #2 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>
84 lines
2.1 KiB
Markdown
84 lines
2.1 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 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)
|
|
|
|
## ${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
|
|
```
|
|
|
|
The config.yml should look like this:
|
|
|
|
```yaml
|
|
steps:
|
|
abapAddonAssemblyKitReserveNextPackages:
|
|
abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
|
|
abapAddonAssemblyKitEndpoint: 'https://myabapAddonAssemblyKitEndpoint.com',
|
|
```
|
|
|
|
### Input via the CommonPipelineEnvironment
|
|
|
|
Mandatory fields:
|
|
|
|
```json
|
|
{"addonProduct":"",
|
|
"addonVersion":"",
|
|
"addonVersionAAK":"",
|
|
"addonUniqueID":"",
|
|
"customerID":"",
|
|
"AddonSpsLevel":"",
|
|
"AddonPatchLevel":"",
|
|
"TargetVectorID":"",
|
|
"repositories":[
|
|
{
|
|
"name":"/DMO/REPO_A",
|
|
"tag":"",
|
|
"branch":"",
|
|
"version":"1.0.1",
|
|
"versionAAK":"",
|
|
"PackageName":"",
|
|
"PackageType":"",
|
|
"SpLevel":"",
|
|
"PatchLevel":"",
|
|
"PredecessorCommitID":"",
|
|
"Status":"",
|
|
"Namespace":"",
|
|
"SarXMLFilePath":""
|
|
},
|
|
{
|
|
"name":"/DMO/REPO_B",
|
|
"tag":"",
|
|
"branch":"",
|
|
"version":"2.1.1",
|
|
"versionAAK":"",
|
|
"PackageName":"",
|
|
"PackageType":"",
|
|
"SpLevel":"",
|
|
"PatchLevel":"",
|
|
"PredecessorCommitID":"",
|
|
"Status":"",
|
|
"Namespace":"",
|
|
"SarXMLFilePath":""
|
|
}
|
|
]}
|
|
```
|