jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-01-18 05:18:24 +02:00
Code Issues Releases Activity

AAKaaS Target Vector steps - Documentation update (#2059)

Browse Source 
* 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

* TV step docu update

* TV step docu update #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>
Co-authored-by: Chris <42861202+bluesbrother84@users.noreply.github.com>
This commit is contained in:
tiloKo 2020-09-23 14:57:45 +02:00 committed by GitHub
parent 54ff93233e
commit e9b7e5e6f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/abapAddonAssemblyKitCreateTargetVector_generated.go
View File

@ -50,7 +50,7 @@ func (p *abapAddonAssemblyKitCreateTargetVectorCommonPipelineEnvironment) persis
}
}
// AbapAddonAssemblyKitCreateTargetVectorCommand This step creates a Target Vector for SPC
// AbapAddonAssemblyKitCreateTargetVectorCommand This step creates a Target Vector for software lifecycle operations
func AbapAddonAssemblyKitCreateTargetVectorCommand() *cobra.Command {
const STEP_NAME = "abapAddonAssemblyKitCreateTargetVector"
@ -61,10 +61,10 @@ func AbapAddonAssemblyKitCreateTargetVectorCommand() *cobra.Command {
var createAbapAddonAssemblyKitCreateTargetVectorCmd = &cobra.Command{
Use: STEP_NAME,
Short: "This step creates a Target Vector for SPC",
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 the software change in ABAP Cloud Platform systems with help of the Software Provider Cockpit (SPC).
It describes the software state, which shall be reached in the managed ABAP Cloud Platform system.`,
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.`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)

10
cmd/abapAddonAssemblyKitPublishTargetVector_generated.go
View File

@ -21,7 +21,7 @@ type abapAddonAssemblyKitPublishTargetVectorOptions struct {
AddonDescriptor string `json:"addonDescriptor,omitempty"`
}
// AbapAddonAssemblyKitPublishTargetVectorCommand This step triggers the publication of the Target Vector to the Service Provider Cockpit system, specified by the Scope.
// AbapAddonAssemblyKitPublishTargetVectorCommand This step triggers the publication of the Target Vector according to the specified scope.
func AbapAddonAssemblyKitPublishTargetVectorCommand() *cobra.Command {
const STEP_NAME = "abapAddonAssemblyKitPublishTargetVector"
@ -31,9 +31,9 @@ func AbapAddonAssemblyKitPublishTargetVectorCommand() *cobra.Command {
var createAbapAddonAssemblyKitPublishTargetVectorCmd = &cobra.Command{
Use: STEP_NAME,
Short: "This step triggers the publication of the Target Vector to the Service Provider Cockpit system, specified by the Scope.",
Long: `This step reads the Target Vector ID from the addonDescriptor in the commonPipelineEnvironment and triggers the publication of the Target Vector to the Service Provider Cockpit system.
With scopeTV "T" the Target Vector will be published to the test SPC and with scopeTV "P" it will be published to public SPC.`,
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.`,
PreRunE: func(cmd *cobra.Command, _ []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)
@ -82,7 +82,7 @@ func addAbapAddonAssemblyKitPublishTargetVectorFlags(cmd *cobra.Command, stepCon
cmd.Flags().StringVar(&stepConfig.AbapAddonAssemblyKitEndpoint, "abapAddonAssemblyKitEndpoint", os.Getenv("PIPER_abapAddonAssemblyKitEndpoint"), "Base URL to the Addon Assembly Kit as a Service (AAKaaS) system")
cmd.Flags().StringVar(&stepConfig.Username, "username", os.Getenv("PIPER_username"), "User for the Addon Assembly Kit as a Service (AAKaaS) system")
cmd.Flags().StringVar(&stepConfig.Password, "password", os.Getenv("PIPER_password"), "Password for the Addon Assembly Kit as a Service (AAKaaS) system")
cmd.Flags().StringVar(&stepConfig.TargetVectorScope, "targetVectorScope", os.Getenv("PIPER_targetVectorScope"), "Determines whether the Target Vector is published to the public SPC('P') or the test SPC('T')")
cmd.Flags().StringVar(&stepConfig.TargetVectorScope, "targetVectorScope", os.Getenv("PIPER_targetVectorScope"), "Determines whether the Target Vector is published to the productive ('P') or test ('T') environment")
cmd.Flags().StringVar(&stepConfig.AddonDescriptor, "addonDescriptor", os.Getenv("PIPER_addonDescriptor"), "Structure in the commonPipelineEnvironment containing information about the Product Version and corresponding Software Component Versions")
cmd.MarkFlagRequired("abapAddonAssemblyKitEndpoint")

6
resources/metadata/abapAddonAssemblyKitCreateTargetVector.yaml
View File

@ -1,10 +1,10 @@
metadata:
name: abapAddonAssemblyKitCreateTargetVector
description: This step creates a Target Vector for SPC
description: This step creates a Target Vector for software lifecycle operations
longDescription: |
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 the software change in ABAP Cloud Platform systems with help of the Software Provider Cockpit (SPC).
It describes the software state, which shall be reached in the managed ABAP Cloud Platform system.
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.
spec:
inputs:
secrets:

8
resources/metadata/abapAddonAssemblyKitPublishTargetVector.yaml
View File

@ -1,9 +1,9 @@
metadata:
name: abapAddonAssemblyKitPublishTargetVector
description: This step triggers the publication of the Target Vector to the Service Provider Cockpit system, specified by the Scope.
description: This step triggers the publication of the Target Vector according to the specified scope.
longDescription: |
This step reads the Target Vector ID from the addonDescriptor in the commonPipelineEnvironment and triggers the publication of the Target Vector to the Service Provider Cockpit system.
With scopeTV "T" the Target Vector will be published to the test SPC and with scopeTV "P" it will be published to public SPC.
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.
spec:
inputs:
secrets:
@ -38,7 +38,7 @@ spec:
secret: true
- name: targetVectorScope
type: string
description: Determines whether the Target Vector is published to the public SPC('P') or the test SPC('T')
description: Determines whether the Target Vector is published to the productive ('P') or test ('T') environment
possibleValues:
- T
- P