From 750750a746a928031ee71c7c45e777e3307a0511 Mon Sep 17 00:00:00 2001 From: Damien Menanteau Date: Thu, 5 Sep 2024 09:16:48 +0200 Subject: [PATCH] [#674] Create mermaid diagrams for 3 main TCR variants (original, btcr and relaxed) --- variants-doc/variant-btcr.mermaid | 25 +++++++++++++++++++++++++ variants-doc/variant-original.mermaid | 20 ++++++++++++++++++++ variants-doc/variant-relaxed.mermaid | 25 +++++++++++++++++++++++++ 3 files changed, 70 insertions(+) create mode 100644 variants-doc/variant-btcr.mermaid create mode 100644 variants-doc/variant-original.mermaid create mode 100644 variants-doc/variant-relaxed.mermaid diff --git a/variants-doc/variant-btcr.mermaid b/variants-doc/variant-btcr.mermaid new file mode 100644 index 00000000..6fa51726 --- /dev/null +++ b/variants-doc/variant-btcr.mermaid @@ -0,0 +1,25 @@ +graph LR + START((start)) + BUILD{build} + TEST{test} + COMMIT["✅ commit (src + tests)"] + REVERT["❌ revert (src + tests)"] + END((end)) + START --> BUILD + BUILD -->|pass| TEST + BUILD -->|fail| END + TEST -->|pass| COMMIT + TEST -->|fail| REVERT + COMMIT --> END + REVERT --> END + classDef boundaryclass fill: #555555 + classDef buildclass fill: #0077CC + classDef testclass fill: #0077CC + classDef okclass fill: #006600 + classDef failclass fill: #660000 + class START boundaryclass + class BUILD buildclass + class TEST testclass + class COMMIT okclass + class REVERT failclass + class END boundaryclass diff --git a/variants-doc/variant-original.mermaid b/variants-doc/variant-original.mermaid new file mode 100644 index 00000000..c5c1682a --- /dev/null +++ b/variants-doc/variant-original.mermaid @@ -0,0 +1,20 @@ +graph LR + START((start)) + TEST{test} + COMMIT["✅ commit src + tests)"] + REVERT["❌ revert (src + tests)"] + END((end)) + START --> TEST + TEST -->|"pass"| COMMIT + TEST -->|"fail"| REVERT + COMMIT --> END + REVERT --> END + classDef boundaryclass fill: #555555 + classDef testclass fill: #0077CC + classDef okclass fill: #006600 + classDef failclass fill: #660000 + class START boundaryclass + class TEST testclass + class COMMIT okclass + class REVERT failclass + class END boundaryclass diff --git a/variants-doc/variant-relaxed.mermaid b/variants-doc/variant-relaxed.mermaid new file mode 100644 index 00000000..ba0f59e2 --- /dev/null +++ b/variants-doc/variant-relaxed.mermaid @@ -0,0 +1,25 @@ +graph LR + START((start)) + BUILD{build} + TEST{test} + COMMIT["✅ commit (src + tests)"] + REVERT["❌ revert (src)"] + END((end)) + START --> BUILD + BUILD -->|pass| TEST + BUILD -->|fail| END + TEST -->|pass| COMMIT + TEST -->|fail| REVERT + COMMIT --> END + REVERT --> END + classDef boundaryclass fill: #555555 + classDef buildclass fill: #0077CC + classDef testclass fill: #0077CC + classDef okclass fill: #006600 + classDef failclass fill: #660000 + class START boundaryclass + class BUILD buildclass + class TEST testclass + class COMMIT okclass + class REVERT failclass + class END boundaryclass