Skip to content

ci: generate ci pipeline diagram from Mermaid - #2957

Merged
leofang merged 8 commits into
NVIDIA:mainfrom
jpascucci-nv:issue2740
Oct 1, 2026
Merged

leofang merged 8 commits into
NVIDIA:mainfrom
jpascucci-nv:issue2740

Conversation

@jpascucci-nv

@jpascucci-nv jpascucci-nv commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Closes #2740

Description

Replace the manually maintained ci/ci-pipeline.svg with a reviewable Mermaid source file.

  • Add ci/ci-pipeline.mmd as the canonical diagram source.
  • Add a command-line tool to regenerate or validate the committed SVG using Mermaid CLI 12.0.0.
  • Remove the old agent-oriented SVG regeneration instructions.
  • Update CONTRIBUTING.md with the regeneration command.
  • Add a focused CI job that detects stale generated output.
  • Update the CI work planner so diagram-only changes run the diagram check without triggering the full CUDA build and test matrix.

Regenerate the diagram with:

console
python3 ci/tools/generate_ci_pipeline.py

Validate it without modifying the committed SVG with:

python3 ci/tools/generate_ci_pipeline.py --check

Testing

  • python3 ci/tools/generate_ci_pipeline.py --check
  • python3 -m unittest ci/tools/tests/test_compute_ci_plan.py
  • pixi run ruff check ci/tools/generate_ci_pipeline.py ci/tools/compute_ci_plan.py ci/tools/tests/test_compute_ci_plan.py
  • pixi run ruff format --check ci/tools/generate_ci_pipeline.py ci/tools/compute_ci_plan.py ci/tools/tests/test_compute_ci_plan.py
  • SPDX validation
  • GitHub Actions workflow YAML validation
  • git diff --check

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@jpascucci-nv jpascucci-nv added this to the cuda.core 1.3.0 milestone Sep 28, 2026
@jpascucci-nv
jpascucci-nv requested a review from mdboom September 28, 2026 14:28
@jpascucci-nv jpascucci-nv self-assigned this Sep 28, 2026
@copy-pr-bot

copy-pr-bot Bot commented Sep 28, 2026

Copy link
Copy Markdown
Contributor

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the CI/CD CI/CD infrastructure label Sep 28, 2026
@jpascucci-nv
jpascucci-nv marked this pull request as ready for review September 28, 2026 14:42
@github-actions

github-actions Bot commented Sep 28, 2026 •

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

Comment thread ci/ci-pipeline.mmd
Comment thread ci/ci-pipeline.svg Outdated

@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.

Less code is always better!

Closes NVIDIA#2740

Description

Replace the manually maintained `ci/ci-pipeline.svg` with a reviewable Mermaid source file.

- Add `ci/ci-pipeline.mmd` as the canonical diagram source.
- Add a command-line tool to regenerate or validate the committed SVG using Mermaid CLI 12.0.0.
- Remove the old agent-oriented SVG regeneration instructions.
- Update `CONTRIBUTING.md` with the regeneration command.
- Add a focused CI job that detects stale generated output.
- Update the CI work planner so diagram-only changes run the diagram check without triggering the full CUDA build and test matrix.

Regenerate the diagram with:

```console
python ci/tools/generate_ci_pipeline.py

Validate it without modifying the committed SVG with:

python ci/tools/generate_ci_pipeline.py --check

Testing
- python3 ci/tools/generate_ci_pipeline.py --check
- python3 -m unittest ci/tools/tests/test_compute_ci_plan.py
- pixi run ruff check ci/tools/generate_ci_pipeline.py ci/tools/compute_ci_plan.py ci/tools/tests/test_compute_ci_plan.py
- pixi run ruff format --check ci/tools/generate_ci_pipeline.py ci/tools/compute_ci_plan.py ci/tools/tests/test_compute_ci_plan.py
- SPDX validation
- GitHub Actions workflow YAML validation
- git diff --check
@leofang
leofang merged commit 2e976bf into NVIDIA:main Oct 1, 2026
116 checks passed
github-actions Bot pushed a commit that referenced this pull request Oct 2, 2026
Removed preview folders for the following PRs:
- PR #2920
- PR #2957
- PR #2973
- PR #2982
- PR #2983
- PR #2990
- PR #2991
- PR #2992
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite ci/ci-pipeline.svg in something text-based

2 participants