From 6a4e22cdb20ae1782f08090a5c32df8f50e89110 Mon Sep 17 00:00:00 2001
From: Whitney Armstrong <warmstrong@anl.gov>
Date: Mon, 23 Aug 2021 13:24:47 -0500
Subject: [PATCH] 	modified:   README.md

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b4768de..ecc6426 100644
--- a/README.md
+++ b/README.md
@@ -53,9 +53,19 @@ The key collaboration/user code repositories are:
 - [Physics benchmarks](https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks) - Analysis of reconstructed for physics performance.  The goal is to provide metrics for optimizing detector design and reconstruction. 
 
 
+### Pipelines and Artifacts
 
+The SWG leverages gitlab's CI/CD features heavily in our workflow.
+Here are some simplified explanations of these.
+
+#### Pipeline 
+
+A pipeline is an automated set of jobs/scripts that are triggered by certain actions, such as pushing a merge request or merging into the master/main branch of a repository.
+Typically there is one pipeline per repository but there can multiple and a pipline can trigger downstream pipelines ("child" pipelines) or it can be triggered by an upstream pipeline. They can also be triggered manually.
+
+The graph below show some of the downstream pipeline triggers (arrows) between different repositories.
 ```mermaid
-graph TD;
+graph pipeline_triggers;
   ip[IP6<br>detectors/ip6] --> athena[ATHENA<br>detectors/athena]
   athena-->db[Detector Benchmarks<br>benchmarks/detector_benchmarks];
   db-->rb[Reconstruct Benchmarks<br>benchmarks/reconstruction_benchmarks];
@@ -64,5 +74,17 @@ graph TD;
   juggler-->pb;
 ```
 
+Note that on any change to the detectors will cause all the benchmarks to be run.
+
+"OK, pipelines run automatically. What is the big deal?
+
+#### Artifacts
+
+All pipeline jobs have "artifacts" which are just selected files that are saved and can be downloaded individually or as a zip file.
+
+Note artifacts are not the output data which is far too big. Artifacts are small files such as images, plots, text files, reports, etc.
+
+
+
 
 
-- 
GitLab