Skip to content

[no-ci] Add CI design principles - #3512

Merged
leofang merged 1 commit into
NVIDIA:mainfrom
leofang:ci-design-principles
Nov 20, 2026
Merged

leofang merged 1 commit into
NVIDIA:mainfrom
leofang:ci-design-principles

Conversation

@leofang

@leofang leofang commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

closes #2346

Adds ci/DESIGN.md, a short statement of the principles behind the CI shared by cuda-python, numba-cuda, numba-cuda-mlir and CuPy, and links it from the CI section of CONTRIBUTING.md.

Please merge this as-is and avoid an extensive debate on the write-up (other than minor wording choices). It is fine if the team chooses to deviate from it, but the design discussions and decisions should be made elsewhere, not in this PR.

This document is not meant to dictate our CI design indefinitely, it's more for serving as a snapshot and a historical document, as well as a useful reference to look back or point agents to (when porting CI code to other repos).

@copy-pr-bot

copy-pr-bot Bot commented Nov 20, 2026

Copy link
Copy Markdown
Contributor

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@leofang leofang added this to the CI milestone Nov 20, 2026
@leofang leofang self-assigned this Nov 20, 2026
@leofang leofang added CI/CD CI/CD infrastructure documentation Improvements or additions to documentation labels Nov 20, 2026
@leofang leofang modified the milestones: CI, cuda.core 1.4.0 Nov 20, 2026
Add ci/DESIGN.md, a short statement of the principles behind the CI
shared by cuda-python, numba-cuda, numba-cuda-mlir and CuPy, and link
it from the CI section of CONTRIBUTING.md.

Closes NVIDIA#2346.

Signed-off-by: Leo Fang <leof@nvidia.com>
@leofang
leofang force-pushed the ci-design-principles branch from 913ab9d to fbec24a Compare November 20, 2026 01:10
@leofang leofang added the P0 High priority - Must do! label Nov 20, 2026
@leofang
leofang marked this pull request as ready for review November 20, 2026 01:29
@coderabbitai

coderabbitai Bot commented Nov 20, 2026

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Added an overview of CI design principles, including build and test practices, supported environments, and guidance for adopting the reference design.
    • Updated the contributor guide to link to the new CI documentation.

The CI infrastructure overview now links to a new document. The document describes CI design principles, supported GPU-testing contexts, and guidance for adopting the reference design.

Changes: CI design documentation

Layer / File(s) Summary
Design document and contribution guide link
CONTRIBUTING.md, ci/DESIGN.md
The CI overview links to the new design document. The document describes CI principles, supported GPU-testing contexts, and repository porting guidance.

Assessment against linked issues

Objective Addressed Explanation
Document the design principles of the current CI infrastructure and link the CI overview to the document [#2346] ✅

Suggested reviewers: mdboom, rwgk

Change: Other

Merge Risk: Minimal · up to fbec2

This change adds a CI design document and links it from the contribution guide. It has no effect on CI behavior or production, so it is safe to merge.

Architecture risk: Low · up to fbec2

The change affects 2 systems.

Changed systems: ci, CONTRIBUTING.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — ci (service) was modified; 1 changed file maps to changed impact.
  • observed — CONTRIBUTING.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CONTRIBUTING.md: Adds a link to the CI design principles document.
  • observed — Modified behavior in ci/DESIGN.md: Adds documentation outlining the CI reference design, its supported GPU-testing contexts, and principles for tooling, containers, cross-platform scripts, build/test separation, installed-wheel testing, declarative configuration, workflow reuse, and repository porting.
- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between faeb2e2 and fbec24a.

Files selected for processing: 2

  • CONTRIBUTING.md
  • ci/DESIGN.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

@leofang

leofang commented Nov 20, 2026

Copy link
Copy Markdown
Member Author

/ok to test fbec24a

@leofang
leofang enabled auto-merge (squash) November 20, 2026 13:16
@leofang
leofang merged commit 3b2ce0b into NVIDIA:main Nov 20, 2026
39 checks passed
@leofang
leofang deleted the ci-design-principles branch November 20, 2026 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure documentation Improvements or additions to documentation P0 High priority - Must do!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CI: Brain-dump the design doc

2 participants