aboutsummaryrefslogtreecommitdiffstats
path: root/roles/prepare/README.md
diff options
context:
space:
mode:
authorMarek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl>2023-03-01 12:27:28 +0100
committerMarek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl>2023-03-03 13:46:02 +0100
commit70fa03898ee412e30b6b87cf961004bf16ccaef4 (patch)
tree10cca3196bd5db69ee643316365a00f1276dba04 /roles/prepare/README.md
parent0399d9842c2a5670e4ee21d45343d2ac168eee2d (diff)
[GATING] Add configuration for Azure3 gating in the fork of chained-ci
This change includes: * moving submodules of chained-ci-roles and chained-ci-vue as static folders to the repo (they were quite old and not updated for some time) * create azure access artifacts * add config for azure3 gating pipeline Issue-ID: INT-2207 Signed-off-by: Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl> Change-Id: Idb475c166d78f10ed4204153ab634110aa9093f6
Diffstat (limited to 'roles/prepare/README.md')
-rw-r--r--roles/prepare/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/roles/prepare/README.md b/roles/prepare/README.md
new file mode 100644
index 0000000..2cdcd0e
--- /dev/null
+++ b/roles/prepare/README.md
@@ -0,0 +1,28 @@
+# Chained CI Prepare role
+
+This role prepare the settings before getting artifacts and run the playbook.
+It:
+ - Warn if log level is HIGH to avoid data leaking
+ - Check the step parameter is set
+ - prepare the `config` fact
+ - test `only` and `except` step parameters to limit when jobs are runned.
+ This will __SKIP__ this job if __ONE of__ the `except` condition is
+ successful __AND__ if __ALL__ the `only` conditions are failing. Those
+ conditions are testing environment variables like this:
+ - `VAR`: this test the presence of a variable that is not empty
+ - `VAR == value`: this test the exact value of a variable
+ - `VAR != value`: this test the exact difference of a variable.
+ - `VAR in [value1, value2]`: this test the exact value of a variable is a
+ set of possibilities
+
+## Example
+
+```
+except:
+ - "XXX in [aaa, aab]"
+ - "YYY"
+only:
+ - "AAA == yes"
+ - "BBB != no"
+ - "CCC in [pitet, possible]"
+```