ABAP Addon: Add details regarding SCR + API snapshot (#5296)

Author: peterpersiel

cmd/abapEnvironmentAssemblePackages_generated.go

@@ -86,6 +86,9 @@ With the following tools the add-on deliveries are created.
     The ABAP Environment platform version of the assembly system is used to determine the minimum platform version for the add-on product version that is created.
     Such a system should not be nominated for the pre-upgrade option of ABAP Environment since then the add-on production could only be installed in systems with the pre-upgrade release.
 
+!!! caution "API Snapshots"
+    During the add-on build any changes to released APIs will be checked for compatibility. The corresponding ATC check can only function properly if there is an API snapshot available in the assembly system. Therefore, make sure to use a permanent system for the assembly if you need to fulfill consistency and stability criteria for your released APIs. Refer to [Checking the Compatibility of Released APIs](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/checking-compatibility-of-released-apis).
+
 The ABAP system responsible for building packages based on software components in the systems. All actions related to the ABAP source code are executed on this system, e.g. running checks with the ABAP test cockpit (ATC) or the physical build of the software components. There are two communication scenarios containing the different APIs of the ABAP environment system: [Test Integration](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html) and [Software Assembly Integration](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html).
 The assembly system should be of service *abap/standard* and be provisioned with parameter `is_development_allowed = false` to prevent local changes.
 
@@ -195,6 +198,9 @@ The leading software component is the software component that is, as opposed to
 In the `repositories` section of the add-on descriptor file the reuse software component should be the first, whereas a leading software component would be the last in order.
 This is to make sure that that the software components are imported in the correct order, making sure to adhere to dependencies.
 
+!!! caution "Software Component Dependencies"
+    In case the involved software components have dependencies between them, define them in [software component relations](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/software-component-relations).
+
 The `version` of a software component influcences two aspects:
 
 - The given version will be used as part of the [target vector](#target-vector)

documentation/docs/scenarios/abapEnvironmentAddons.md

@@ -30,6 +30,7 @@
 * The Software Components for which packages are to be assembled need to be present in the system.
   * This can be done manually through the respective applications on the SAP BTP, ABAP environment system.
   * In a pipeline, you can do this, for example, with the step [abapEnvironmentPullGitRepo](https://sap.github.io/jenkins-library/steps/abapEnvironmentPullGitRepo/).
+  * In case multiple software component are used, any dependencies between the components need to be defined in [Software Component Relations](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/software-component-relations).
 * The packages to be assembled need to be reserved in AAKaaS and the corresponding information needs to be present in CommonPipelineEnvironment. To do so run step [abapAddonAssemblyKitReserveNextPackages](https://sap.github.io/jenkins-library/steps/abapAddonAssemblyKitReserveNextPackages/) prior this step.
 
 ## ${docGenParameters}

documentation/docs/steps/abapEnvironmentAssemblePackages.md

@@ -2,8 +2,12 @@ metadata:
   name: abapEnvironmentAssemblePackages
   description: "Assembly of installation, support package or patch in SAP BTP ABAP Environment system"
   longDescription: |
-    This step runs the assembly of a list of provided [installations, support packages or patches](https://help.sap.com/viewer/9043aa5d2f834ad385e1cdfdadc06b6f/LATEST/en-US/9a81f55473568c77e10000000a174cb4.html) in SAP Cloud
-    Platform ABAP Environment system and saves the corresponding [SAR archive](https://launchpad.support.sap.com/#/notes/212876) to the filesystem.
+    This step runs the assembly of a list of provided [installations, support packages or patches](https://help.sap.com/viewer/9043aa5d2f834ad385e1cdfdadc06b6f/LATEST/en-US/9a81f55473568c77e10000000a174cb4.html) in SAP BTP ABAP Environment system and saves the corresponding [SAR archive](https://launchpad.support.sap.com/#/notes/212876) to the filesystem.
+    <br />
+    Among others a semantic version [API snapshot](https://help.sap.com/docs/btp/sap-business-technology-platform/creating-api-snapshots?version=Cloud) will be
+    searched and marked as check-relevant in the assembly system, ATC checks for [consistency of software component dependencies](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/software-component-relations) as well as [API compatibility](https://help.sap.com/docs/abap-cloud/abap-development-tools-user-guide/checking-compatibility-of-released-apis) will run, and a new semantic version API snapshot will be created as well.
+    <br />
+    Refer to [Software Assembly Integration (SAP_COM_0582)](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/26b8df5435c649aa8ea7b3688ad5bb0a.html).
 spec:
   inputs:
     secrets: