Skip to content

Add CI infrastructure overview with hand-drawn SVG diagram, Mermaid alternative, and enhanced artifact flow visualization to CONTRIBUTING.md - #916

Merged
leofang merged 28 commits into
mainfrom
copilot/fix-915
Sep 9, 2025
Merged

Add CI infrastructure overview with hand-drawn SVG diagram, Mermaid alternative, and enhanced artifact flow visualization to CONTRIBUTING.md#916
leofang merged 28 commits into
mainfrom
copilot/fix-915

Conversation

Copilot AI commented Aug 28, 2025

Copy link
Copy Markdown
Contributor
  • Add CI infrastructure overview with hand-drawn SVG diagram and artifact flow visualization to CONTRIBUTING.md
  • Create vectorized SVG diagram with color-coded stages for better visualization
  • Address review feedback: remove specific runner names, fix GPU model references, update cache descriptions
  • Convert SVG to hand-drawn Excalidraw-style design with rough, sketchy borders
  • Add artifact flow arrows showing mini CTK cache reuse and wheel fetching
  • Create comprehensive regeneration reference file for future updates
  • Add Mermaid diagram alternative for interactive visualization
  • Enhanced artifact flow arrows to TEST STAGE showing both mini CTK reuse and wheel fetch dependencies
  • Document parallel execution details for build and test stages
  • Add table of contents and reorganize document structure
  • Fix SVG arrow colors and add wheel upload label based on review feedback
  • Change artifact flow arrows from black to orange for consistent visual language
  • Update Mermaid diagram to include wheel upload arrow with orange dashed styling

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@copy-pr-bot

copy-pr-bot Bot commented Aug 28, 2025

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.

- Added cuda-pathfinder component to the component guidelines list
- Added footnote explaining cuda.bindings follows cuda-python contributing guide
- Added comprehensive CI infrastructure overview section with:
  - Visual flowchart diagram showing build → test → release pipeline
  - Platform and runner details (self-hosted vs GitHub-hosted)
  - Artifact storage and propagation (GitHub Artifacts vs Cache)
  - Branch-specific workflows (main, backport, pull-request)
  - Key infrastructure details

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Copilot AI changed the title [WIP] MNT: Add CI infrastructure diagram to CONTRIBUTING.md Add CI infrastructure overview to CONTRIBUTING.md Aug 28, 2025
Copilot AI requested a review from leofang August 28, 2025 03:05

@leofang leofang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot

The flow looks ok. But I'd like to highlight

  • cuda-pathfinder artifact flows from the main branch's artifact space to that of the backport branch
  • older cuda-bindings artifacts flow in the opposite direction

Please find a way to present it in the flowchart.

Also, if possible please generate a vectorized .svg file, and let's see how it looks. We will decide later if we want to revert back to the ascii-based one, like what you've generated.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
…add SVG diagram

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

Copilot AI commented Aug 28, 2025

Copy link
Copy Markdown
Contributor Author

@copilot

The flow looks ok. But I'd like to highlight
...

I've updated the flowchart to highlight the artifact flows between branches and created an SVG version as requested. The branch-specific artifact flow section now explicitly shows:

  • cuda-pathfinder artifacts flowing from main branch to backport branches
  • older cuda-bindings artifacts flowing from backport branches to main branch

I've also created a vectorized SVG diagram (ci-pipeline.svg) with color-coded stages for better visualization. The documentation now includes both the SVG version and the ASCII version for different viewing preferences.

Commit: 2816809

Copilot AI changed the title Add CI infrastructure overview to CONTRIBUTING.md Add CI infrastructure overview with SVG diagram to CONTRIBUTING.md Aug 28, 2025
Copilot AI requested a review from leofang August 28, 2025 03:21

@leofang leofang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot

Comment thread ci-pipeline.svg Outdated
Comment thread CONTRIBUTING.md Outdated
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Copilot AI requested a review from leofang August 28, 2025 03:40

@leofang leofang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot

Comment thread CONTRIBUTING.md Outdated
Comment thread ci/ci-pipeline.svg
…ayout

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Copilot AI requested a review from leofang August 28, 2025 03:47
Comment thread ci/ci-pipeline.svg
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Copilot AI changed the title Add CI infrastructure overview with SVG diagram to CONTRIBUTING.md Add CI infrastructure overview with hand-drawn SVG diagram to CONTRIBUTING.md Aug 28, 2025

Copilot AI commented Sep 8, 2025

Copy link
Copy Markdown
Contributor Author

@copilot throughout this PR, I don't want to mention "Push to pull-request/* branches" as a trigger event. As mentioned in an earlier comment, this is an implementation detail of the CI that is out of...

Removed "Push to pull-request/* branches" trigger event from all CI documentation files as requested. Updated CONTRIBUTING.md Mermaid diagram, ci/ci-pipeline.svg, and ci/.ci-pipeline-regen.md regeneration instructions to exclude implementation-specific triggers.

Commit: 9ce239a

Copilot AI requested a review from leofang September 8, 2025 00:37
Comment thread ci/ci-pipeline.svg Outdated
@leofang
leofang marked this pull request as ready for review September 8, 2025 00:42
@leofang
leofang requested a review from rparolin September 8, 2025 00:42
@leofang leofang added P2 Low priority - Nice to have and removed P1 Medium priority - Should do labels Sep 8, 2025
rparolin
rparolin previously approved these changes Sep 8, 2025

@rparolin rparolin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 lgtm

Comment thread CONTRIBUTING.md
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Copilot AI changed the title Add CI infrastructure overview with hand-drawn SVG diagram and artifact flow visualization to CONTRIBUTING.md Add CI infrastructure overview with hand-drawn SVG diagram, Mermaid alternative, and enhanced artifact flow visualization to CONTRIBUTING.md Sep 8, 2025
Copilot AI requested a review from leofang September 8, 2025 18:56
Comment thread ci/ci-pipeline.svg Outdated
Comment thread ci/ci-pipeline.svg Outdated
Comment thread CONTRIBUTING.md Outdated
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Copilot AI requested a review from leofang September 8, 2025 19:46

@rwgk rwgk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still some minor glitches (a couple superfluous arrows), but I think this isn't worth our time, it's already great for merging.

@leofang

leofang commented Sep 9, 2025

Copy link
Copy Markdown
Member

Thanks, Ralf & Rob!

There are still some minor glitches (a couple superfluous arrows), but I think this isn't worth our time

Yeah I am really unhappy with the arrow heads, but the SVG code looks fine to me and I don't have time to dig further.

FWIW, I meant to ask if you have any preference over SVG or Mermaid. I don't, so let me keep both for now and wait until someone has an opinion 🙂

@leofang
leofang merged commit cf13790 into main Sep 9, 2025
1 check passed
@github-actions

github-actions Bot commented Sep 9, 2025

Copy link
Copy Markdown
Doc Preview CI
Preview removed because the pull request was closed or merged.

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 P2 Low priority - Nice to have

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants