Skip to content

Commit 135fe2e

Browse files
committed
Add Mermaid architecture diagrams to README
1 parent 8dd807b commit 135fe2e

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

README.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,93 @@ The GitHub Actions extension lets you manage your workflows, view the workflow r
44

55
![](./media/header.png)
66

7+
## Architecture Overview
8+
9+
<!-- If the Mermaid diagrams below aren't rendering in VS Code preview, install the "Markdown Preview Mermaid Support" extension -->
10+
11+
```mermaid
12+
graph TB
13+
subgraph "VS Code Extension"
14+
EXT[Extension Host]
15+
TV[Tree Views]
16+
CMD[Commands]
17+
TRACK[Workspace Tracker]
18+
end
19+
20+
subgraph "Language Support"
21+
LC[Language Client]
22+
LS[Language Server]
23+
WP[Workflow Parser]
24+
EE[Expression Engine]
25+
end
26+
27+
subgraph "External Services"
28+
GH[GitHub API]
29+
REPO[Git Repository]
30+
end
31+
32+
EXT --> LC
33+
EXT --> TV
34+
EXT --> CMD
35+
EXT --> TRACK
36+
37+
LC <--> LS
38+
LS --> WP
39+
LS --> EE
40+
WP --> EE
41+
42+
TV --> GH
43+
CMD --> GH
44+
TRACK --> REPO
45+
LS --> GH
46+
47+
style EXT fill:#2ea44f
48+
style LS fill:#0969da
49+
style GH fill:#8250df
50+
```
51+
52+
### Key Components
53+
54+
```mermaid
55+
graph LR
56+
subgraph "User Interface"
57+
WF[Workflows View]
58+
CB[Current Branch View]
59+
SET[Settings View]
60+
EDITOR[Workflow Editor]
61+
end
62+
63+
subgraph "Core Features"
64+
AUTH[Authentication]
65+
MANAGE[Workflow Management]
66+
LOGS[Log Viewing]
67+
VALID[Validation & Completion]
68+
end
69+
70+
subgraph "Data Management"
71+
STORE[Run Store]
72+
SECRETS[Secrets/Variables]
73+
PIN[Pinned Workflows]
74+
end
75+
76+
WF --> MANAGE
77+
WF --> PIN
78+
CB --> MANAGE
79+
SET --> SECRETS
80+
EDITOR --> VALID
81+
82+
MANAGE --> STORE
83+
MANAGE --> AUTH
84+
LOGS --> STORE
85+
VALID --> AUTH
86+
SECRETS --> AUTH
87+
PIN --> MANAGE
88+
89+
style AUTH fill:#fd8c73
90+
style MANAGE fill:#58a6ff
91+
style VALID fill:#3fb950
92+
```
93+
794
## Features
895

996
### Manage workflows and runs

0 commit comments

Comments
 (0)