Skip to content

Commit 62daffc

Browse files
Michael HallikMichael Hallik
authored andcommitted
Add Mermaid diagrams
1 parent 89176c4 commit 62daffc

2 files changed

Lines changed: 60 additions & 0 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
```mermaid
2+
flowchart TD
3+
A[Fork repo] --> B[Create feature branch]
4+
B --> C[Code, test & commit]
5+
C --> D[Push to fork]
6+
D --> E[Open pull request to main]
7+
E --> F[GitHub Actions run]
8+
9+
F -->|✅ Pass| G[Code review]
10+
F -->|❌ Fail| L[Push changes to branch]
11+
L --> F
12+
13+
G -->|✅ Approved| H[PR merged into main]
14+
G -->|❌ Changes requested| L
15+
```

docs/images/github_actions.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# test.yml
2+
3+
```mermaid
4+
flowchart TD
5+
A[Trigger: push or PR to main] --> B[Job: test - ubuntu-latest]
6+
B --> C
7+
8+
subgraph StepGroup [ ]
9+
direction TB
10+
C[Checkout Repository]
11+
C --> D[Set Up Python]
12+
D --> E[Cache Poetry Dependencies]
13+
E --> F[Install Dependencies]
14+
F --> G[Show Poetry Configuration]
15+
G --> H[Add Poetry 'bin' Dir To PATH]
16+
H --> I[Log sys.path]
17+
I --> J[Run Unit Tests]
18+
J --> K[Install pytest Annotation Plugin]
19+
K --> L[Upload Coverage Report]
20+
L --> M[Ensure 'results' Dir exists]
21+
M --> N[Run Integration Tests]
22+
N --> O[Upload Test Report]
23+
end
24+
25+
style StepGroup stroke-dasharray: 4 4,stroke:#999
26+
```
27+
28+
# lint.yml
29+
30+
```mermaid
31+
flowchart TD
32+
A[Trigger: push or PR to main/master] --> B[Job: lint - ubuntu-latest]
33+
B --> C
34+
35+
subgraph StepGroup [ ]
36+
direction TB
37+
C[Checkout Repository]
38+
C --> D[Set Up Python]
39+
D --> E[Install Dependencies]
40+
E --> F[Run Pylint]
41+
F --> G[Run Pyright]
42+
end
43+
44+
style StepGroup stroke-dasharray: 4 4,stroke:#999
45+
```

0 commit comments

Comments
 (0)