github.com/xgoffin/jenkins-library@v1.154.0/documentation/docs/steps/abapAddonAssemblyKitCheckPV.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ### Artifacts
     6  
     7  - addonDescriptorFile (addon.yml)
     8      The addonDescriptorFile as specified in parameter addonDescriptorFileName is archived as artifact. This is done as this file is the main configuration and usually changed with every run. Thus it simplifies support if the corresponding configuration file is directly accessible in the pipeline.
     9  
    10  ## Prerequisites
    11  
    12  * The credentials to access the AAKaaS (Technical Communication User) must be stored in the Jenkins Credential Store
    13  * The step needs an addon.yml containing information about the Product Version and corresponding Software Component Versions/Repositories
    14  
    15  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/).
    16  
    17  ## ${docGenParameters}
    18  
    19  ## ${docGenConfiguration}
    20  
    21  ## ${docJenkinsPluginDependencies}
    22  
    23  ## Examples
    24  
    25  ### Configuration in the config.yml
    26  
    27  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:
    28  
    29  ```groovy
    30  abapAddonAssemblyKitCheckPV script: this
    31  ```
    32  
    33  If the step is to be configured individually the config.yml should look like this:
    34  
    35  ```yaml
    36  steps:
    37    abapAddonAssemblyKitCheckCVs:
    38      abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
    39      addonDescriptorFileName: 'addon.yml'
    40  ```
    41  
    42  More convenient ways of configuration (e.g. on stage level) are described in the respective scenario/pipeline documentation.