jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-11-06 09:09:19 +02:00
Code Issues Releases Activity

Docu updates abap steps (#2910)

Browse Source 
* docu updates

* go generate

* remove example as better explained in scenario docu

* Update abapAddonAssemblyKitCheckCVs_generated.go

* PV Step update

* md lint

* create TV

* publish TV

* lint

* register

* release

* reserve

* yaml lint

* Update abapAddonAssemblyKitRegisterPackages_generated.go

* Update resources/metadata/abapAddonAssemblyKitCreateTargetVector.yaml

Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>

* Update resources/metadata/abapAddonAssemblyKitPublishTargetVector.yaml

Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>

* refer

Co-authored-by: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com>
This commit is contained in:
tiloKo
2021-06-17 21:28:15 +02:00
committed by GitHub
parent 29b991d6fc
commit 9db249fe1c
21 changed files with 101 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
cmd/abapAddonAssemblyKitCheckCVs_generated.go
View File

@@ -52,7 +52,7 @@ func (p *abapAddonAssemblyKitCheckCVsCommonPipelineEnvironment) persist(path, re
}
}
// AbapAddonAssemblyKitCheckCVsCommand This step checks the validity of Software Component Versions.
// AbapAddonAssemblyKitCheckCVsCommand This step checks the validity of ABAP Software Component Versions.
func AbapAddonAssemblyKitCheckCVsCommand() *cobra.Command {
const STEP_NAME = "abapAddonAssemblyKitCheckCVs"
@@ -64,9 +64,11 @@ func AbapAddonAssemblyKitCheckCVsCommand() *cobra.Command {
var createAbapAddonAssemblyKitCheckCVsCmd = &cobra.Command{
Use: STEP_NAME,
Short: "This step checks the validity of Software Component Versions.",
Long: `This steps takes a list of Software Component Versions from the addonDescriptorFileName and checks whether they exist or are a valid successor of an existing Software Component Version.
It resolves the dotted version string into version, support package level and patch level and writes it to the commonPipelineEnvironment.`,
Short: "This step checks the validity of ABAP Software Component Versions.",
Long: `This steps takes the list of ABAP Software Component Versions(repositories) from the addonDescriptor configuration file specified via addonDescriptorFileName (e.g. addon.yml) and checks by calling AAKaaS whether they exist or are a valid successor of an existing Software Component Version.
It resolves the dotted version string into version, support package level and patch level and writes it to the addonDescriptor structure in the Piper commonPipelineEnvironment for usage of subsequent pipeline steps.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)
@@ -148,12 +150,12 @@ func abapAddonAssemblyKitCheckCVsMetadata() config.StepData {
Metadata: config.StepMetadata{
Name: "abapAddonAssemblyKitCheckCVs",
Aliases: []config.Alias{},
Description: "This step checks the validity of Software Component Versions.",
Description: "This step checks the validity of ABAP Software Component Versions.",
},
Spec: config.StepSpec{
Inputs: config.StepInputs{
Secrets: []config.StepSecrets{
{Name: "abapAddonAssemblyKitCredentialsId", Description: "Credential stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system", Type: "jenkins"},
{Name: "abapAddonAssemblyKitCredentialsId", Description: "CredentialsId stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system", Type: "jenkins"},
},
Parameters: []config.StepParameters{
{

8
cmd/abapAddonAssemblyKitCheckPV_generated.go
View File

@@ -65,8 +65,10 @@ func AbapAddonAssemblyKitCheckPVCommand() *cobra.Command {
var createAbapAddonAssemblyKitCheckPVCmd = &cobra.Command{
Use: STEP_NAME,
Short: "This step checks the validity of a Addon Product Version.",
Long: `This step checks whether the Addon Product Version in the addonDescriptorFileName does exist or is a valid successor of an existing Product Version.
It resolves the dotted version string into version, support package stack level and patch level and writes it to the commonPipelineEnvironment.`,
Long: `This step checks by calling AAKaaS whether the Addon Product Version in the addonDescriptor configuration file specified via addonDescriptorFileName (e.g. addon.yml) does exist or is a valid successor of an existing Product Version.
It resolves the dotted version string into version, support package stack level and patch level and writes it to the addonDescriptor structure in the Piper commonPipelineEnvironment for usage of subsequent pipeline steps.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)
@@ -153,7 +155,7 @@ func abapAddonAssemblyKitCheckPVMetadata() config.StepData {
Spec: config.StepSpec{
Inputs: config.StepInputs{
Secrets: []config.StepSecrets{
{Name: "abapAddonAssemblyKitCredentialsId", Description: "Credential stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system", Type: "jenkins"},
{Name: "abapAddonAssemblyKitCredentialsId", Description: "CredentialsId stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system", Type: "jenkins"},
},
Parameters: []config.StepParameters{
{

4
cmd/abapAddonAssemblyKitCreateTargetVector_generated.go
View File

@@ -66,7 +66,9 @@ func AbapAddonAssemblyKitCreateTargetVectorCommand() *cobra.Command {
Short: "This step creates a Target Vector for software lifecycle operations",
Long: `This step takes the Product Version and the corresponding list of Software Component Versions from the addonDescriptor in the commonPipelineEnvironment.
With these it creates a Target Vector, which is necessary for executing software lifecylce operations in ABAP Cloud Platform systems.
The Target Vector describes the software state, which shall be reached in the managed ABAP Cloud Platform system.`,
The Target Vector describes the software state, which shall be reached in the managed ABAP Cloud Platform system.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)

4
cmd/abapAddonAssemblyKitPublishTargetVector_generated.go
View File

@@ -35,7 +35,9 @@ func AbapAddonAssemblyKitPublishTargetVectorCommand() *cobra.Command {
Use: STEP_NAME,
Short: "This step triggers the publication of the Target Vector according to the specified scope.",
Long: `This step reads the Target Vector ID from the addonDescriptor in the commonPipelineEnvironment and triggers the publication of the Target Vector.
With targetVectorScope "T" the Target Vector will be published to the test environment and with targetVectorScope "P" it will be published to the productive environment.`,
With targetVectorScope "T" the Target Vector will be published to the test environment and with targetVectorScope "P" it will be published to the productive environment.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)

14
cmd/abapAddonAssemblyKitRegisterPackages_generated.go
View File

@@ -51,7 +51,7 @@ func (p *abapAddonAssemblyKitRegisterPackagesCommonPipelineEnvironment) persist(
}
}
// AbapAddonAssemblyKitRegisterPackagesCommand This step uploads the SAR archives and creates physical Delivery Packages in in the File Content Management System of SAP.
// AbapAddonAssemblyKitRegisterPackagesCommand This step uploads the SAR archives and creates physical Delivery Packages to AAKaaS.
func AbapAddonAssemblyKitRegisterPackagesCommand() *cobra.Command {
const STEP_NAME = "abapAddonAssemblyKitRegisterPackages"
@@ -63,11 +63,13 @@ func AbapAddonAssemblyKitRegisterPackagesCommand() *cobra.Command {
var createAbapAddonAssemblyKitRegisterPackagesCmd = &cobra.Command{
Use: STEP_NAME,
Short: "This step uploads the SAR archives and creates physical Delivery Packages in in the File Content Management System of SAP.",
Short: "This step uploads the SAR archives and creates physical Delivery Packages to AAKaaS.",
Long: `This step takes the list of Software Component Versions from the addonDescriptor in the commonPipelineEnvironment.
For Packages in status "P"lanned it uploads the SAR archive with the data file and metadata XML of the Delivery Packages composed and exported in the Final Assembly system.
and creates physical Delivery Packages. The Packages ares saved in the File Content Management System of SAP.
The new status "L"ocked is written back to the addonDescriptor in the commonPipelineEnvironment.`,
For Packages in status "P" = planned it uploads the SAR archive with the data file and metadata XML of the Delivery Packages composed and exported in the build system
and creates physical Delivery Package in AAKaaS.
The new status "L" = locked is written back to the addonDescriptor in the commonPipelineEnvironment.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)
@@ -148,7 +150,7 @@ func abapAddonAssemblyKitRegisterPackagesMetadata() config.StepData {
Metadata: config.StepMetadata{
Name: "abapAddonAssemblyKitRegisterPackages",
Aliases: []config.Alias{},
Description: "This step uploads the SAR archives and creates physical Delivery Packages in in the File Content Management System of SAP.",
Description: "This step uploads the SAR archives and creates physical Delivery Packages to AAKaaS.",
},
Spec: config.StepSpec{
Inputs: config.StepInputs{

5
cmd/abapAddonAssemblyKitReleasePackages_generated.go
View File

@@ -65,8 +65,9 @@ func AbapAddonAssemblyKitReleasePackagesCommand() *cobra.Command {
Use: STEP_NAME,
Short: "This step releases the physical Delivery Packages",
Long: `This step takes the list of Software Component Versions from the addonDescriptor in the commonPipelineEnvironment.
The physical Delivery Packages in status “L” are released and uploaded to the "ABAP CP" section in the SAP artifactory object
store. The new status "R"eleased is written back to the addonDescriptor in the commonPipelineEnvironment.`,
The physical Delivery Packages in status “L” are released. The new status "R"eleased is written back to the addonDescriptor in the commonPipelineEnvironment.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)

6
cmd/abapAddonAssemblyKitReserveNextPackages_generated.go
View File

@@ -67,9 +67,11 @@ func AbapAddonAssemblyKitReserveNextPackagesCommand() *cobra.Command {
Long: `This step takes the list of Software Component Versions from the addonDescriptor in the commonPipelineEnvironment and determines the ABAP delivery packages.
If a package does not exist yet in the package registry, it is created there. The response contains detail information for this package and a package status, which determines the next actions:
"P": Package was created in the registry; production can be started / continued
"R": Package exists and is already released; production is not needed and must be skipped
"R": Package exists and is already released; production is not needed and will be skipped
The steps waits until the status "P" or "R" is achieved.
The name, type and namespace of each package is written back to the addonDescriptor in the commonPipelineEnvironment.`,
The name, type and namespace of each package is written back to the addonDescriptor in the commonPipelineEnvironment.
<br />
For Terminology refer to the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)