Skip to content

Commit 1046d42

Browse files
mcgrofmcgrof
committed
docs/kernel-ci: use mermaid for flow chart
GitHub has support for fow charts in mermaid [0] and claud AI easily assisted to create this for us [1]. All bow to the new overlords. [0] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams [1] https://claude.site/artifacts/5987e018-b6d7-420e-bec3-5ed144fbe707 Signed-off-by: Luis Chamberlain <[email protected]>
1 parent b9e7570 commit 1046d42

File tree

2 files changed

+99
-61
lines changed

2 files changed

+99
-61
lines changed

‎docs/kernel-ci/README.md‎

Lines changed: 37 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -24,67 +24,43 @@ Both self-hosted runners and cloud solutions can be used. Manually running
2424
kdevops tests is also possible. Below we provide an ASCII art image
2525
representation of what this looks like.
2626

27-
```
28-
+---------------------------------------------+ +---------------------------
29-
| Mailing List Patches | | Direct dev branch pushes |
30-
|---------------------------------------------| |---------------------------|-
31-
| - Patches submitted to mailing lists | | - Developers push |
32-
| - Example: linux-modules vger list | | branches directly |
33-
+----------------------+----------------------+ +-------------------+-------
34-
| |
35-
| |
36-
v v
37-
+----------------+ +--------------------------+
38-
| Patchwork | | Topic KPD Tree |
39-
|----------------| |--------------------------|
40-
| - Tracks patch | | - Receives branches from |
41-
| submissions | | dev-tree from KPD App |
42-
| - Sends series | | and direct developer |
43-
| to GitHub | | pushes |
44-
+----------------+ | - Adds `kdevops-ci` as |
45-
| | the first commit for |
46-
| | patches from Patchwork |
47-
v | - Developers merge |
48-
+--------------------------+ | `kdevops-ci` as the |
49-
| GitHub KPD Topic |---> |last step in their dev |
50-
| App | +----------+--------------+
51-
|--------------------------+ |
52-
| - Adds `kdevops-ci` as | |
53-
| the first commit and | |
54-
| applies patch series | |
55-
| - Pushes branch to KPD | |
56-
| topic tree | |
57-
+--------------------------+ |
58-
|
59-
v
60-
+--------------------------+
61-
| github CI / gitlab CI |
62-
|--------------------------|
63-
| - Executes CI workflows |
64-
| on topic branches |
65-
| - Uses kdevops for |
66-
| testing workflows |
67-
| - Uploads zip artifacts |
68-
+--------------------------+
69-
|
70-
v
71-
+--------------------------+
72-
| kdevops |
73-
|--------------------------|
74-
| - Orchestrates testing |
75-
| configurations |
76-
| - Manages ansible tasks |
77-
| - pushes the results to
78-
| kdevops-results-archive|
79-
+--------------------------+
80-
|
81-
v
82-
+--------------------------+
83-
| kdevops-results-archive |
84-
|--------------------------|
85-
| - Archives results in |
86-
| using (git LFS) |
87-
+--------------------------+
27+
* [Alternative ASCII flow chart](kdevops-ci-ascii-flow-chart.md)
28+
29+
```mermaid
30+
flowchart TD
31+
ML[Mailing List Patches] -->|Submit| PW[Patchwork]
32+
DP[Direct dev branch pushes] -->|Push| KT[Topic KPD Tree]
33+
34+
subgraph Patch Processing
35+
PW -->|Send series| GA[GitHub KPD Topic App]
36+
GA -->|Push branch| KT
37+
end
38+
39+
subgraph Topic Tree Management
40+
KT -->|Trigger| CI[GitHub CI / GitLab CI]
41+
end
42+
43+
subgraph Testing and Results
44+
CI -->|Execute workflows| KD[kdevops]
45+
KD -->|Archive results| KRA[kdevops-results-archive]
46+
end
47+
48+
%% Node descriptions
49+
ML -->|"- Patches submitted to mailing lists\n- Example: linux-modules vger list"|ML
50+
PW -->|"- Tracks patch submissions\n- Sends series to GitHub"|PW
51+
GA -->|"- Adds 'kdevops-ci' as first commit\n- Applies patch series\n- Pushes branch to KPD topic tree"|GA
52+
KT -->|"- Receives branches from dev-tree\n- Adds 'kdevops-ci' as first commit\n- Developers merge 'kdevops-ci'"|KT
53+
CI -->|"- Executes CI workflows\n- Uses kdevops for testing\n- Uploads zip artifacts"|CI
54+
KD -->|"- Orchestrates testing configs\n- Manages ansible tasks\n- Pushes results"|KD
55+
KRA -->|"- Archives results using git LFS"|KRA
56+
57+
classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px;
58+
classDef process fill:#e1f3e1,stroke:#333,stroke-width:2px;
59+
classDef storage fill:#e1e1f3,stroke:#333,stroke-width:2px;
60+
61+
class ML,DP default;
62+
class PW,GA,KT,CI,KD process;
63+
class KRA storage;
8864
```
8965

9066
# Active kdevops CIs

‎docs/kernel-ci/kdevops-ci-ascii-flow-chart.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
```
2+
+---------------------------------------------+ +---------------------------
3+
| Mailing List Patches | | Direct dev branch pushes |
4+
|---------------------------------------------| |---------------------------|-
5+
| - Patches submitted to mailing lists | | - Developers push |
6+
| - Example: linux-modules vger list | | branches directly |
7+
+----------------------+----------------------+ +-------------------+-------
8+
| |
9+
| |
10+
v v
11+
+----------------+ +--------------------------+
12+
| Patchwork | | Topic KPD Tree |
13+
|----------------| |--------------------------|
14+
| - Tracks patch | | - Receives branches from |
15+
| submissions | | dev-tree from KPD App |
16+
| - Sends series | | and direct developer |
17+
| to GitHub | | pushes |
18+
+----------------+ | - Adds `kdevops-ci` as |
19+
| | the first commit for |
20+
| | patches from Patchwork |
21+
v | - Developers merge |
22+
+--------------------------+ | `kdevops-ci` as the |
23+
| GitHub KPD Topic |---> |last step in their dev |
24+
| App | +----------+--------------+
25+
|--------------------------+ |
26+
| - Adds `kdevops-ci` as | |
27+
| the first commit and | |
28+
| applies patch series | |
29+
| - Pushes branch to KPD | |
30+
| topic tree | |
31+
+--------------------------+ |
32+
|
33+
v
34+
+--------------------------+
35+
| github CI / gitlab CI |
36+
|--------------------------|
37+
| - Executes CI workflows |
38+
| on topic branches |
39+
| - Uses kdevops for |
40+
| testing workflows |
41+
| - Uploads zip artifacts |
42+
+--------------------------+
43+
|
44+
v
45+
+--------------------------+
46+
| kdevops |
47+
|--------------------------|
48+
| - Orchestrates testing |
49+
| configurations |
50+
| - Manages ansible tasks |
51+
| - pushes the results to
52+
| kdevops-results-archive|
53+
+--------------------------+
54+
|
55+
v
56+
+--------------------------+
57+
| kdevops-results-archive |
58+
|--------------------------|
59+
| - Archives results in |
60+
| using (git LFS) |
61+
+--------------------------+
62+
```

0 commit comments

Comments
 (0)