Capabilities overview of Pipeline Templates

Templates/README.md

@@ -1,15 +1,69 @@
 # Pipeline Templates
 
-This category provides templates to implement a CI/CD pipeline covering the entire development lifecycle. These assets are developed based on [The Git-based process you need for Mainframe development](https://ibm.github.io/z-devops-acceleration-program/docs/git-branching-model-for-mainframe-dev) and help you to quickly setup your pipeline environment. Please make yourself familiar with the outlined Git branching model.
+This category provides templates to implement a CI/CD pipeline covering the entire development lifecycle. These assets are developed based on [The Git branching model for mainframe development](https://ibm.github.io/z-devops-acceleration-program/docs/git-branching-model-for-mainframe-dev) and help you to quickly setup your pipeline environment. Prior to implementing these templates, you should get familiar with the outlined Git branching model.
 
 ## Table of Contents 
 Asset | Description | Documentation Link
 --- | --- | ---
-Common-Backend-Scripts | Core asset to simplify defining the pipeline orchestration by providing central services for the various stages of the CI/CD pipeline. Especially useful for pipeline architectures which don't provide a native runner .  | [Common-Backend-Scripts/README.md](Common-Backend-Scripts/README.md)
+Common-Backend-Scripts | Core asset to simplify defining the pipeline orchestration by providing central services for the various stages of the CI/CD pipeline. Especially useful for pipeline architectures which don't provide a native runner . | [Common-Backend-Scripts/README.md](Common-Backend-Scripts/README.md)
 Azure DevOps Pipeline Template | Template to setup a [AzureDevOps pipeline](https://learn.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops&viewFallbackFrom=azure-pipelines) to build, package and deploy Azure Repos Git. | [AzureDevOpsPipeline/README.md](AzureDevOpsPipeline/README.md)
 Gitlab CI/CD Pipeline Template | .gitlab-ci.yml template to setup a [Gitlab CI/CD pipeline](https://docs.gitlab.com/ee/ci/pipelines/) to build, package and deploy Gitlab platform. | [GitlabCIPipeline/README.md](GitlabCIPipeline/README.md)
 GitHub Actions Pipeline Template | Template to setup a [GitHub Actions Pipeline](https://docs.github.com/en/actions) to build, package, and deploy a GitHub repository. | [GitHubActionsPipeline/README.md](GitHubActionsPipeline/README.md)
 Jenkins Multibranch Pipeline Template | Multibranch pipeline template to setup a [Jenkins CI/CD pipeline](https://www.jenkins.io/doc/book/pipeline/multibranch/) to build, package and deploy with any Git provider. | [JenkinsPipeline/README.md](JenkinsPipeline/README.md)
 
-
 Please use the [Github discussion](https://github.com/IBM/dbb/discussions) board for feedback and comments on these templates.
+
+
+## Capabilities of Pipeline Templates 
+
+The below tables provide an overview of the implemented capabilities of the pipeline templates. The information can be used to lookup and understand the variations in the implementations. The :red_circle: icon indicates that this step uses a [Common Backend Script](Common-Backend-Scripts/).
+
+### Technology in use with CI/CD orchestrators
+
+ <br>  | Azure DevOps | GitLab CI | GitHub Actions | Jenkins
+--- | --- | --- | --- | ---
+**CI Runner/Agent topology** | ADO runner | gitlab-runner shell executor | GitHub Actions runner | Jenkins node on z/OS
+**Git Provider** | Azure DevOps | GitLab | GitHub | Any Git provider
+**Deployment technology** | IBM Wazi Deploy | IBM Wazi Deploy | IBM Wazi Deploy | IBM DevOps Deploy (a.k.a. UCD)
+**Communication between CI platform and z/OS** | SSH | IBM RSE API Plug-in for Zowe CLI | SSH | Jenkins-managed
+**Additional integration technologies** | Azure DevOps CLI | GitLab REST interface | GitHub CLI | 
+**Pipeline extensions** |       |       |      | SonarQube sonar-scanner
+
+### Implemented pipeline tasks
+
+All templates implement the recommended working practice, that is documented within the [IBM zDevOps Guide](https://ibm.github.io/z-devops-acceleration-program/docs/git-branching-model-for-mainframe-dev).
+It is made of:
+* a **feature branch pipeline**, that provides an early feedback to developers about the impacted components of their changes, building a preliminary package that can be tested in an isolated environment,
+* an **integration pipeline**, that is triggered when merging changes into an integration branch such as the `main`, `release` maintenance or `epic` branch
+* a **release pipeline**, that builds all contributed changes for the iteration, creates a release candidate package and allows to drive deployments into controlled test environments.
+
+The below table provides an overview of the capabilities that are implemented in the various templates. The second column in the table indicates for which types of pipeline the capability is available:   
+:small_blue_diamond: feature branch pipeline  
+:small_orange_diamond: build pipeline for integration branches  
+:small_red_triangle: release pipeline  
+
+Capability | Pipeline types | Azure DevOps | GitLab CI | GitHub Actions | Jenkins
+--- | :-: | --- | --- | --- | ---
+**Clone Git repository** | :small_blue_diamond::small_orange_diamond::small_red_triangle: | :red_circle: gitClone.sh | :red_circle: gitClone.sh | :red_circle: gitClone.sh | Jenkins Git Plugin
+**Build** | :small_blue_diamond::small_orange_diamond::small_red_triangle: | :red_circle: dbbBuild.sh | :red_circle: dbbBuild.sh | :red_circle: dbbBuild.sh | :red_circle: dbbBuild.sh
+**Publish Build Logs** | :small_blue_diamond::small_orange_diamond::small_red_triangle: | :red_circle: prepareLogs.sh and sftp to load and attach logs | :red_circle: prepareLogs.sh and sftp to load and attach logs | :red_circle: prepareLogs.sh and zowe CLI rse to load and attach logs | Jenkins artifactPublisher plugin
+**Code Quality and Scans** | :small_blue_diamond::small_orange_diamond::small_red_triangle: | - | - | - | SonarQube Scan
+**Creation of release candidate tag** | :small_red_triangle: | Computation of the release candidate and planned release name <br> Creation of the release candidate Tag in ADO via the ADO CLI | Computation of the release candidate and planned release name <br> Creation of the release candidate Git tag in Gitlab via REST | Computation of the release candidate and planned release name <br> Creation of a pre-release via GH CLI for the release candidate | Computation of the UCD package name. No tagging in Git (independent of the Git provider).
+**Create package** | :small_blue_diamond::small_orange_diamond::small_red_triangle: | :red_circle: packageBuildOutputs.sh | :red_circle: packageBuildOutputs.sh | :red_circle: packageBuildOutputs.sh | :red_circle: ucdPackaging.sh to create UCD component version <br> Create Link to UCD to Pipeline run
+**Publish Package** | :small_orange_diamond::small_red_triangle: | Upload to Azure Artifacts | - | - | Depending on UCD buztool configuration
+*Deployment to Integration Test environment* | | | | | 
+**Deployment Integration Test environment** | :small_orange_diamond::small_red_triangle: | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> | :red_circle: ucdDeploy.sh. Create Link to UCD Deployment request to Pipeline run
+**Publish deployment logs** | :small_orange_diamond::small_red_triangle: | :red_circle: prepareLogs.sh <br> and sftp upload | :red_circle: prepareLogs.sh <br> and sftp upload | :red_circle: prepareLogs.sh <br> and sftp upload | Create UCD Deployment Link in Pipeline run
+<br> | <br> | Copy WD Evidence File to Evidence Inventory | Copy WD Evidence File to Evidence Inventory | <br>
+*Deployment to Acceptance Test environment* | | | | | 
+**Retrieve Deployment Package** | :small_red_triangle: | Download from ADO package registry | Package from pipeline working directory is used | Package from pipeline working directory is used | Not part of the pipeline template
+**Deployment Acceptance Test environment** | :small_red_triangle: | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> | Not part of the pipeline template
+<br> | <br> | <br> | Copy WD Evidence File to Evidence Inventory | Copy WD Evidence File to Evidence Inventory | <br>
+**Publish deployment logs** | :small_red_triangle: | :red_circle: prepareLogs.sh <br> and sftp upload | :red_circle: prepareLogs.sh <br> and sftp upload | :red_circle: prepareLogs.sh <br> and sftp upload | Not part of the pipeline template
+*Deployment to Production environment* | | | | | 
+**Retrieve Deployment Package** | :small_red_triangle: | Download from ADO package registry | The package from pipeline working directory is used | Package from pipeline working directory is used | Not part of the pipeline template
+**Deployment Production environment** | :small_red_triangle: | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> Register deployment to environment in ADO | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> Register deployment to environment in GitHub | :red_circle: wazideploy-generate.sh <br> :red_circle: wazideploy-deploy.sh <br> :red_circle: wazideploy-evidence.sh <br> | Not part of the pipeline template
+<br> | <br> | Copy WD Evidence File to Evidence Inventory | Copy WD Evidence File to Evidence Inventory | <br>
+**Publish deployment logs** | :small_red_triangle: | :red_circle: prepareLogs.sh <br> and sftp upload | :red_circle: prepareLogs.sh <br> and sftp upload | :red_circle: prepareLogs.sh <br> and sftp upload | Not part of the pipeline template
+**Release Finalisation** | :small_red_triangle: | Creation of a Git tag via ADO CLI | Creation of a Git tag and release via GH CLI | Creation of a Git tag via GitLab via REST <br> Automated update of the `baselineReference.conf` file | No automated tagging
+**Workspace Cleanup** | :small_blue_diamond::small_orange_diamond::small_red_triangle: | :red_circle: deleteWorkspace.sh | :red_circle: deleteWorkspace.sh | :red_circle: deleteWorkspace.sh | Jenkins Plugin