Skip to content

Commit 5390921

Browse files
authored
Merge pull request #535 from github/users/ericsciple/25-12-diagram
Add Mermaid architecture diagrams to README
2 parents 8dd807b + 3401e2b commit 5390921

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,49 @@ Be more confident when authoring and modifying workflows. Find errors before com
4141
1. Open a GitHub repository.
4242
1. You will be able to utilize the syntax features in Workflow files, and you can find the GitHub Actions icon on the left navigation to manage your Workflows.
4343

44+
## Key Components
45+
46+
<!-- If the Mermaid diagrams below aren't rendering in VS Code preview, install the "Markdown Preview Mermaid Support" extension -->
47+
48+
```mermaid
49+
graph LR
50+
subgraph "User Interface"
51+
WF[Workflows View]
52+
CB[Current Branch View]
53+
SET[Settings View]
54+
EDITOR[Workflow Editor]
55+
end
56+
57+
subgraph "Core Features"
58+
AUTH[Authentication]
59+
MANAGE[Workflow Management]
60+
LOGS[Log Viewing]
61+
VALID[Validation & Completion]
62+
end
63+
64+
subgraph "Data Management"
65+
STORE[Run Store]
66+
SECRETS[Secrets/Variables]
67+
PIN[Pinned Workflows]
68+
end
69+
70+
WF --> MANAGE
71+
WF --> PIN
72+
CB --> MANAGE
73+
SET --> SECRETS
74+
EDITOR --> VALID
75+
76+
MANAGE --> STORE
77+
MANAGE --> AUTH
78+
LOGS --> STORE
79+
VALID --> AUTH
80+
SECRETS --> AUTH
81+
PIN --> MANAGE
82+
83+
style AUTH fill:#fd8c73
84+
style MANAGE fill:#58a6ff
85+
style VALID fill:#3fb950
86+
```
4487

4588
## Supported Features
4689

@@ -57,6 +100,49 @@ We have enabled experimental functionality to support GitHub Enterprise Server,
57100

58101
We currently do not have the capability to support Operating System (OS) certificates or enterprise proxies (we plan to support pulling from the VS Code proxy settings), but we have plans for it in the future and it is on our backlog!
59102

103+
## Architecture Overview
104+
105+
```mermaid
106+
graph TB
107+
subgraph "VS Code Extension"
108+
EXT[Extension Host]
109+
TV[Tree Views]
110+
CMD[Commands]
111+
TRACK[Workspace Tracker]
112+
end
113+
114+
subgraph "Language Support"
115+
LC[Language Client]
116+
LS[Language Server]
117+
WP[Workflow Parser]
118+
EE[Expression Engine]
119+
end
120+
121+
subgraph "External Services"
122+
GH[GitHub API]
123+
REPO[Git Repository]
124+
end
125+
126+
EXT --> LC
127+
EXT --> TV
128+
EXT --> CMD
129+
EXT --> TRACK
130+
131+
LC <--> LS
132+
LS --> WP
133+
LS --> EE
134+
WP --> EE
135+
136+
TV --> GH
137+
CMD --> GH
138+
TRACK --> REPO
139+
LS --> GH
140+
141+
style EXT fill:#2ea44f
142+
style LS fill:#0969da
143+
style GH fill:#8250df
144+
```
145+
60146
## Contributing
61147

62148
See [CONTRIBUTING.md](CONTRIBUTING.md). A description of the architecture of the extension can be found [here](./docs/project-architecture.md).

0 commit comments

Comments
 (0)