Skip to content

Commit

Permalink
[#674] Create mermaid diagrams for 3 main TCR variants (original, btc…
Browse files Browse the repository at this point in the history
…r and relaxed)
  • Loading branch information
mengdaming committed Sep 11, 2024
1 parent c1aac0a commit 750750a
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
25 changes: 25 additions & 0 deletions variants-doc/variant-btcr.mermaid
Original file line number Diff line number Diff line change
@@ -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
20 changes: 20 additions & 0 deletions variants-doc/variant-original.mermaid
Original file line number Diff line number Diff line change
@@ -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
25 changes: 25 additions & 0 deletions variants-doc/variant-relaxed.mermaid
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 750750a

Please sign in to comment.