From fbeb333740b945aa67e3c9d778c5b2b2b0b206f0 Mon Sep 17 00:00:00 2001 From: Marcel Baur Date: Mon, 15 Aug 2022 15:24:15 +0200 Subject: [PATCH] add relevant code tags // fix typos --- doc/Integration-Pipeline.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/Integration-Pipeline.md b/doc/Integration-Pipeline.md index b836ddb..6a589f4 100644 --- a/doc/Integration-Pipeline.md +++ b/doc/Integration-Pipeline.md @@ -4,46 +4,46 @@ overview -The integration pipeline is part of the development process. It contains several functions with provide help with promotions and deployment. +The integration pipeline is part of the development process. It contains several functions which provide help with promotions and deployment. The following image sketches how the pipeline is interacting with the rest of the build process. -Every component triggers the function trackComponentVersions. The function gathers the data of the build an stores this in the file component-versions.yaml which is archived for every build. +Every component triggers the function `trackComponentVersions`. The function gathers the data of the build and stores this in the file `component-versions.yaml`, which is archived for every build. component-a -When the build job was successful finished it automatically triggers the integration pipeline job. -This job also contains the function trackComponentVersions. The result of the function is also a component-version.yaml. But in contrast to the build job the integration pipeline aggregates the information from the upstream build that it was triggered by and updates only the changed component and the component-version.yaml from the last successful integration pipeline build. -Additionally the integration pipeline needs an own version.yaml (in the repository). This can be empty or it may contain external components with are necessary for a deployment. These information's will be added to the component-version.yaml +When the build job was successfully finished, it automatically triggers the integration pipeline job. +This job also contains the function `trackComponentVersions`. The result of the function also creates a `component-version.yaml`. But in contrast to the build job, the integration pipeline aggregates the information from the upstream build that it was triggered by and updates only the changed component and the `component-version.yaml` from the last successful integration pipeline build. +Additionally, the integration pipeline needs its own `version.yaml` (in the repository). This can be empty or it may contain external components which are necessary for deployment. This information will be added to the `component-version.yaml`. integration-pipeline-overview -Once the integration pipeline has successfully gathered all information a `Deploy` badge will be applied to the job overview. -This is done by the function addDeployLinks. This link triggers the deployment pipeline with the information of the integration pipeline (e.g. job-name and build-number). -This procedure ensures that only the component versions stored in the component-versions.yaml are deployed when triggering the deployment pipeline. +Once the integration pipeline has successfully gathered all information, a `Deploy` badge will be applied to the job overview. +This is done by the function `addDeployLinks`. This link triggers the deployment pipeline with the information of the integration pipeline (e.g. job-name and build-number). +This procedure ensures that only the component versions stored in the `component-versions.yaml` are deployed when triggering the deployment pipeline. -Once the `Deploy` badge is activated the deployment pipeline is triggered. -This pipeline contains the function deployChangedComponents. +Once the `Deploy` badge is activated, the deployment pipeline is triggered. +This pipeline contains the function `deployChangedComponents`. ---- **NOTE** The function has yet only generic content. -Right now it just maps a rundeck file with defines the jobs that need to be run for a deployment. -To use the full functionality it has to be refactored. +Right now it just maps a rundeck file, which defines the jobs that need to be run for deployment. +To use the full functionality, it has to be refactored. ---- -Once the Deployment is done the job in the deployment pipeline is marked with a star for the deployment on the specific environment. +Once the Deployment is done, the job in the deployment pipeline is marked with a star for the deployment on the specific environment. deployment-pipeline-overview You will find additional information on the detail page of the deployment pipeline: -* deployed-components.yaml will show you which components have been installed +* `deployed-components.yaml` will show you which components have been installed * a badge with the information which integration pipeline triggered the installation deployment-pipeline-detail -Futhermore the badge is also applied in the integration pipeline job that triggered the deployment. +Futhermore, the badge is also applied in the integration pipeline job that triggered the deployment. ## needed plugins