Skip to content

Commit 01fd78c

Browse files
Copilothuangyiirene
Copilot
and
huangyiirene
committed
docs: add visual workflow diagram for better understanding
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 3fad804 commit 01fd78c

File tree

1 file changed

+222
-0
lines changed

1 file changed

+222
-0
lines changed

‎.github/WORKFLOW_DIAGRAM.md‎

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
# Workflow Triggers & Flow Diagram
2+
3+
```
4+
┌─────────────────────────────────────────────────────────────────────────────┐
5+
│ GITHUB ACTIONS WORKFLOWS │
6+
└─────────────────────────────────────────────────────────────────────────────┘
7+
8+
┌──────────────────┐
9+
│ Push to Main │
10+
└────────┬─────────┘
11+
│
12+
├─────────────────┐
13+
│ │
14+
▼ ▼
15+
┌────────┐ ┌──────────┐
16+
│ CI │ │ Release │
17+
└────────┘ └──────────┘
18+
- Test - Changesets
19+
- Build - Publish npm
20+
- Coverage
21+
- Type Check
22+
│
23+
▼
24+
[Artifacts]
25+
26+
27+
┌──────────────────┐
28+
│ Pull Request │
29+
└────────┬─────────┘
30+
│
31+
├──────────────┬──────────────┬─────────────────┐
32+
│ │ │ │
33+
▼ ▼ ▼ ▼
34+
┌────────┐ ┌──────────┐ ┌─────────────┐ ┌──────────────┐
35+
│ CI │ │ CodeQL │ │ Lint │ │ PR Automation│
36+
└────────┘ └──────────┘ └─────────────┘ └──────────────┘
37+
- Test - Security - Type Check - Size Labels
38+
- Build - Scanning - Auto Labels
39+
- Changesets
40+
41+
42+
┌──────────────────┐
43+
│ Scheduled │
44+
└────────┬─────────┘
45+
│
46+
├──────────────┬──────────────┬──────────────┐
47+
│ │ │ │
48+
▼ ▼ ▼ ▼
49+
┌────────┐ ┌──────────┐ ┌─────────────┐ ┌──────────┐
50+
│ Stale │ │ CodeQL │ │ Validate │ │Dependabot│
51+
└────────┘ └──────────┘ │ Deps │ └──────────┘
52+
Daily Weekly Mon └─────────────┘ Weekly Mon
53+
01:00 UTC 02:00 UTC Weekly Mon (Auto PRs)
54+
03:00 UTC
55+
56+
57+
┌──────────────────┐
58+
│ Manual Trigger │
59+
└────────┬─────────┘
60+
│
61+
├──────────────┬──────────────┐
62+
│ │ │
63+
▼ ▼ ▼
64+
┌────────┐ ┌──────────┐ ┌─────────────┐
65+
│ Docs │ │ Stale │ │ Validate │
66+
└────────┘ └──────────┘ │ Deps │
67+
Deploy Clean Up └─────────────┘
68+
Security Scan
69+
70+
71+
┌─────────────────────────────────────────────────────────────────────────────┐
72+
│ AUTOMATION FLOW │
73+
└─────────────────────────────────────────────────────────────────────────────┘
74+
75+
Developer creates PR
76+
│
77+
▼
78+
┌───────────────────┐
79+
│ PR Created │
80+
└────────┬──────────┘
81+
│
82+
├─── CI runs tests ────────────────┐
83+
│ │
84+
├─── Lint checks types ────────────┤
85+
│ │
86+
├─── CodeQL scans security ────────┤
87+
│ │
88+
├─── PR Automation │
89+
│ - Adds size label ├──→ [Feedback to Dev]
90+
│ - Adds category labels │
91+
│ - Checks changeset │
92+
│ │
93+
└───────────────────────────────────┘
94+
│
95+
▼
96+
┌────────────────┐
97+
│ Review & Merge │
98+
└────────┬───────┘
99+
│
100+
▼
101+
┌────────────────┐
102+
│ Main Branch │
103+
└────────┬───────┘
104+
│
105+
├─── CI (test + build) ───────┐
106+
│ │
107+
├─── Docs deploy ──────────────┤
108+
│ │
109+
├─── Release workflow │
110+
│ - Create release PR ├──→ [npm publish]
111+
│ - Or publish if merged │
112+
│ │
113+
└──────────────────────────────┘
114+
115+
116+
┌─────────────────────────────────────────────────────────────────────────────┐
117+
│ MAINTENANCE CYCLE │
118+
└─────────────────────────────────────────────────────────────────────────────┘
119+
120+
Monday 01:00 UTC Monday 02:00 UTC Monday 03:00 UTC
121+
│ │ │
122+
▼ ▼ ▼
123+
┌────────┐ ┌──────────┐ ┌─────────────┐
124+
│ Stale │ │ CodeQL + │ │ Validate │
125+
│ Check │ │Dependabot│ │ Deps │
126+
└────────┘ └──────────┘ └─────────────┘
127+
Marks old Security scan Audit packages
128+
issues/PRs + Creates PRs List outdated
129+
130+
131+
Daily 01:00 UTC
132+
│
133+
▼
134+
┌────────┐
135+
│ Stale │
136+
│Manager │
137+
└────────┘
138+
Closes old
139+
issues/PRs
140+
141+
142+
┌─────────────────────────────────────────────────────────────────────────────┐
143+
│ ARTIFACT & OUTPUT FLOW │
144+
└─────────────────────────────────────────────────────────────────────────────┘
145+
146+
CI Test Job CI Build Job
147+
│ │
148+
▼ ▼
149+
┌─────────────┐ ┌─────────────┐
150+
│ Coverage │ │ Build │
151+
│ Report │ │ Artifacts │
152+
└─────────────┘ └─────────────┘
153+
(30 days) (30 days)
154+
│ │
155+
├──────────────┬───────────────┤
156+
│ │ │
157+
▼ ▼ ▼
158+
[Download] [Review] [Documentation]
159+
Site
160+
│
161+
▼
162+
GitHub Pages
163+
164+
165+
┌─────────────────────────────────────────────────────────────────────────────┐
166+
│ SECURITY WORKFLOW │
167+
└─────────────────────────────────────────────────────────────────────────────┘
168+
169+
┌──────────────┐
170+
│ Code Push │
171+
└──────┬───────┘
172+
│
173+
├────────────────┬───────────────┐
174+
│ │ │
175+
▼ ▼ ▼
176+
┌──────────┐ ┌──────────┐ ┌──────────┐
177+
│ CodeQL │ │Dependency│ │ License │
178+
│ Scan │ │ Audit │ │ Check │
179+
└──────────┘ └──────────┘ └──────────┘
180+
│ │ │
181+
└────────────────┴───────────────┘
182+
│
183+
▼
184+
┌───────────────┐
185+
│ Security │
186+
│ Tab │
187+
└───────────────┘
188+
View all alerts
189+
```
190+
191+
## Summary Statistics
192+
193+
| Category | Count |
194+
|----------|-------|
195+
| **Workflows** | 8 files |
196+
| **Triggers** | Push, PR, Schedule, Manual |
197+
| **Jobs** | 12+ total jobs |
198+
| **Languages Scanned** | JavaScript/TypeScript |
199+
| **Caching** | pnpm store (all workflows) |
200+
| **Artifacts** | Coverage + Build (30 days) |
201+
| **Scheduled Tasks** | 4 (Stale daily, 3 weekly) |
202+
| **Auto-labels** | 9 categories |
203+
204+
## Dependencies
205+
206+
- Node.js: 20
207+
- pnpm: 10.28.0
208+
- GitHub Actions versions:
209+
- checkout: v4
210+
- setup-node: v4
211+
- cache: v4
212+
- pnpm/action-setup: v4
213+
- upload-artifact: v4
214+
- deploy-pages: v4
215+
- codeql-action: v3
216+
- stale: v9
217+
- labeler: v5
218+
219+
---
220+
221+
*Generated: 2026-01-19*
222+
*Maintained by: GitHub Actions Automation*

0 commit comments

Comments
 (0)