github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/abapAddonAssemblyKitCheckCVs.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  * The credentials to access the AAKaaS (Technical Communication User) must be stored in the Jenkins Credential Store
     8  * The step needs an addon.yml containing information about the Product Version and corresponding Software Component Versions/Repositories
     9  
    10  A detailed description of all prerequisites of the scenario and how to configure them can be found in the [Scenario Description](https://www.project-piper.io/scenarios/abapEnvironmentAddons/).
    11  
    12  ## ${docGenParameters}
    13  
    14  ## ${docGenConfiguration}
    15  
    16  ## ${docJenkinsPluginDependencies}
    17  
    18  ## Examples
    19  
    20  ### Configuration in the config.yml
    21  
    22  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:
    23  
    24  ```groovy
    25  abapAddonAssemblyKitCheckPV script: this
    26  ```
    27  
    28  If the step is to be configured individually the config.yml should look like this:
    29  
    30  ```yaml
    31  steps:
    32    abapAddonAssemblyKitCheckCVs:
    33      abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
    34      addonDescriptorFileName: 'addon.yml'
    35  ```
    36  
    37  More convenient ways of configuration (e.g. on stage level) are described in the respective scenario/pipeline documentation.