Skip to content

Commit 2816809

Browse files
Copilotleofang
andcommitted
Address CI infrastructure feedback: update flowchart, fix footnotes, add SVG diagram
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
1 parent c119422 commit 2816809

2 files changed

Lines changed: 133 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Thank you for your interest in contributing to CUDA Python! Based on the type of
1111
2. You want to implement a feature, improvement, or bug fix:
1212
- Please refer to each component's guideline:
1313
- [`cuda.core`](https://nvidia.github.io/cuda-python/cuda-core/latest/contribute.html)
14-
- [`cuda.bindings`](https://nvidia.github.io/cuda-python/cuda-bindings/latest/contribute.html)¹
14+
- [`cuda.bindings`](https://nvidia.github.io/cuda-python/cuda-bindings/latest/contribute.html)<sup>[1](#footnote1)</sup>
1515
- [`cuda.pathfinder`](https://nvidia.github.io/cuda-python/cuda-pathfinder/latest/contribute.html)
1616

1717

@@ -21,6 +21,10 @@ The CUDA Python project uses a comprehensive CI pipeline that builds, tests, and
2121

2222
### CI Pipeline Flow
2323

24+
#### Visual Diagram (SVG)
25+
![CUDA Python CI Pipeline Flow](ci-pipeline.svg)
26+
27+
#### Text-based Diagram (ASCII)
2428
```
2529
┌─────────────────────────────────────────────────────────────────────────────────────┐
2630
│ TRIGGER EVENTS │
@@ -35,7 +39,7 @@ The CUDA Python project uses a comprehensive CI pipeline that builds, tests, and
3539
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
3640
│ │ linux-64 │ │ linux-aarch64 │ │ win-64 │ │
3741
│ │ Self-hosted │ │ Self-hosted │ │ GitHub-hosted │ │
38-
│ │ linux-amd64-cpu8│ │ linux-arm64-cpu8│ │ windows-2022 │ │
42+
│ │ (runners) │ │ (runners) │ │ (runners) │ │
3943
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
4044
│ │
4145
│ • Python versions: 3.9, 3.10, 3.11, 3.12, 3.13 │
@@ -49,10 +53,10 @@ The CUDA Python project uses a comprehensive CI pipeline that builds, tests, and
4953
│ │
5054
│ ┌──────────────────────────┐ ┌──────────────────────────┐ │
5155
│ │ GitHub Artifacts │ │ GitHub Cache │ │
52-
│ │ • Wheel files (.whl) │ │ • Build dependencies │ │
53-
│ │ • Test artifacts │ │ • Compiled binaries │ │
54-
│ │ • Documentation │ │ • Python environments │ │
55-
│ │ (30-day retention) │ │ • Package caches │ │
56+
│ │ • Wheel files (.whl) │ │ • Mini CTK cache │ │
57+
│ │ • Test artifacts │ │ │ │
58+
│ │ • Documentation │ │ │ │
59+
│ │ (30-day retention) │ │ │ │
5660
│ └──────────────────────────┘ └──────────────────────────┘ │
5761
└─────────────────────────────────────────────────────────────────────────────────────┘
5862
@@ -64,7 +68,7 @@ The CUDA Python project uses a comprehensive CI pipeline that builds, tests, and
6468
│ │ linux-64 │ │ linux-aarch64 │ │ win-64 │ │
6569
│ │ Self-hosted │ │ Self-hosted │ │ GitHub-hosted │ │
6670
│ │ GPU runners │ │ GPU runners │ │ GPU runners │ │
67-
│ │ (L4/A100) │ │ (A100) │ │ │ │
71+
│ │ │ │ │ │ │ │
6872
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
6973
│ │
7074
│ • Download wheels from artifacts │
@@ -95,11 +99,14 @@ The CUDA Python project uses a comprehensive CI pipeline that builds, tests, and
9599
- **Build****Test****Documentation****Potential Release**
96100
- Artifacts stored as `{component}-python{version}-{platform}-{sha}`
97101
- Full test coverage across all platforms and CUDA versions
102+
- **Artifact flow out**: `cuda-pathfinder` artifacts → backport branches
98103

99104
#### Backport Branches
100105
- **Build****Test****Backport PR Creation**
101106
- Artifacts used for validation before creating backport pull requests
102107
- Maintains compatibility with older CUDA versions
108+
- **Artifact flow in**: `cuda-pathfinder` artifacts ← main branch
109+
- **Artifact flow out**: older `cuda-bindings` artifacts → main branch
103110

104111
#### Pull Request Branches (`pull-request/*`)
105112
- **Build****Test****Status Check**
@@ -184,4 +191,4 @@ By making a contribution to this project, I certify that:
184191

185192
---
186193

187-
¹ `cuda.bindings` follows the contributing guidelines from this repository (`cuda-python`).
194+
<a id="footnote1">1</a>: `cuda.bindings` follows the contributing guidelines from this repository (`cuda-python`).

ci-pipeline.svg

Lines changed: 118 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)