github.com/xgoffin/jenkins-library@v1.154.0/documentation/docs/steps/abapAddonAssemblyKitRegisterPackages.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  * This step needs the names of the packages which should be registered. For each package a SAR archive with the data file and metadata XML must be provided.
     9  * The package names and their status are taken from the addonDescriptor in the commonPipelineEnvironment, as well as the SarXMLFilePath with the path to the SAR file.
    10  * The information will be written to the commonPipelineEnvironment if you run prior to this step the step [abapAddonAssemblyKitReserveNextPackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReserveNextPackages)
    11  * The SAR archive is produced if you run the step [abapEnvironmentAssemblePackages](https://sap.github.io/jenkins-library/steps/abapEnvironmentAssemblePackages)
    12  
    13  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/).
    14  
    15  ## ${docGenParameters}
    16  
    17  ## ${docGenConfiguration}
    18  
    19  ## ${docJenkinsPluginDependencies}
    20  
    21  ## Examples
    22  
    23  ### Configuration in the config.yml
    24  
    25  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:
    26  
    27  ```groovy
    28  abapAddonAssemblyKitRegisterPackages script: this
    29  ```
    30  
    31  If the step is to be configured individually the config.yml should look like this:
    32  
    33  ```yaml
    34  steps:
    35    abapAddonAssemblyKitRegisterPackages:
    36      abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId'
    37  ```
    38  
    39  More convenient ways of configuration (e.g. on stage level) are described in the respective scenario/pipeline documentation.