Skip to content

Conversation

rmccorm4
Copy link
Contributor

@rmccorm4 rmccorm4 commented Aug 28, 2025

Overview:

Iterative improvement on only running certain actions when necessary

Summary by CodeRabbit

  • Chores
    • CI pipelines now skip runs when changes are documentation-only (Markdown/ReStructuredText), reducing noise and speeding up builds for container validation and general trigger workflows on pushes and pull requests.
    • Pre-merge Rust checks are streamlined to run only when Rust-related files change (e.g., .rs and Cargo files), making validations more targeted and faster.
    • No impact on application behavior; workflows and results remain the same outside of these trigger optimizations.

…hanges

Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
@rmccorm4 rmccorm4 requested review from nnshah1 and a team as code owners August 28, 2025 23:52
@github-actions github-actions bot added the ci Issues/PRs that reference CI build/test label Aug 28, 2025
Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
Copy link
Contributor

coderabbitai bot commented Aug 29, 2025

Walkthrough

Updates four GitHub Actions workflows to adjust triggers: add docs-only paths-ignore filters to several workflows (push and/or pull_request) and narrow PR path filters in the Rust pre-merge workflow to only Rust-related files. No job logic changes.

Changes

Cohort / File(s) Summary of changes
Docs-only CI skip (push)
.github/workflows/container-validation-backends.yml, .github/workflows/trigger_ci.yml
Add on.push.paths-ignore for **/*.md and **/*.rst to prevent runs on docs-only commits. Indentation adjusted as needed.
Docs-only CI skip (push and PR)
.github/workflows/container-validation-dynamo.yml
Add paths-ignore for **/*.md and **/*.rst under both on.push and on.pull_request. Minor newline formatting change in a step.
PR path filter narrowed to Rust
.github/workflows/pre-merge-rust.yml
Remove directory-based filters; keep only **/*.rs, Cargo.toml, Cargo.lock under on.pull_request.paths. Update inline comment accordingly.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    actor Dev as Developer
    participant GH as GitHub
    participant WF as Workflow Dispatcher
    participant Jobs as Workflow Jobs

    Dev->>GH: Push or Pull Request
    GH->>WF: Evaluate workflow triggers
    alt Docs-only changes (md/rst)
        WF-->>GH: paths-ignore matched (skip)
    else Non-docs changes
        WF->>Jobs: Start workflow
        Jobs-->>WF: Run steps
        WF-->>GH: Report status
    end
Loading
sequenceDiagram
    autonumber
    actor Dev as Developer
    participant GH as GitHub
    participant WF as pre-merge-rust.yml
    participant Jobs as Rust Checks

    Dev->>GH: Open/Update PR
    GH->>WF: Check on.pull_request.paths
    alt Changes include .rs/Cargo files
        WF->>Jobs: Run Rust pre-merge workflow
        Jobs-->>WF: Lint/Test/Build results
        WF-->>GH: Status posted
    else Other files or directories
        WF-->>GH: No run (filtered)
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

A bunny taps the workflow keys,
“Skip the docs,” it softly pleas.
Rust gets first dibs when PRs flow,
YAML paths decide the show.
Carrots queued when green lights gleam—
CI hops swift, a tidy stream. 🥕✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (4)
.github/workflows/trigger_ci.yml (1)

23-26: Broaden docs-only ignore to cover common doc assets.

Include mdx/notebooks/images and the docs/ tree to reduce unnecessary runs.

Apply:

     # Skip docs only changes
     paths-ignore:
       - '**/*.md'
       - '**/*.rst'
+      - '**/*.mdx'
+      - '**/*.ipynb'
+      - 'docs/**'
+      - '**/*.png'
+      - '**/*.svg'
.github/workflows/container-validation-backends.yml (1)

11-14: Consider skipping docs-only PRs too for parity with push.

If desired, mirror the push ignore on pull_request. Confirm branch protection rules won’t require this workflow on docs-only PRs.

Proposed change:

 on:
   push:
     branches:
       - main
       - "pull-request/[0-9]+"
     # Skip docs only changes
     paths-ignore:
       - '**/*.md'
       - '**/*.rst'
+  pull_request:
+    # Skip docs only changes
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.rst'

Optionally broaden ignores (mdx/ipynb/docs/**/images) as done in trigger_ci.

.github/workflows/pre-merge-rust.yml (1)

24-30: Include Rust build and policy files in pull_request paths
Add these under pull_request.paths in .github/workflows/pre-merge-rust.yml:

     paths:
       - .github/workflows/pre-merge-rust.yml
       - '**.rs'
       - 'Cargo.toml'
       - 'Cargo.lock'
+      - '**/*.proto'
+      - 'deny.toml'
+      - 'rust-toolchain*'
+      - '.cargo/**'
.github/workflows/container-validation-dynamo.yml (1)

9-13: Broaden push docs-only ignore to cut redundant builds.

Align with other workflow suggestion: include mdx/notebooks/docs tree/images.

Apply:

   push:
     branches:
       - main
     # Skip docs only changes
     paths-ignore:
       - '**/*.md'
       - '**/*.rst'
+      - '**/*.mdx'
+      - '**/*.ipynb'
+      - 'docs/**'
+      - '**/*.png'
+      - '**/*.svg'
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ea0c002 and 1a7990f.

📒 Files selected for processing (4)
  • .github/workflows/container-validation-backends.yml (1 hunks)
  • .github/workflows/container-validation-dynamo.yml (2 hunks)
  • .github/workflows/pre-merge-rust.yml (1 hunks)
  • .github/workflows/trigger_ci.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Build and Test - dynamo
  • GitHub Check: pre-merge-rust (lib/bindings/python)
  • GitHub Check: pre-merge-rust (.)
  • GitHub Check: pre-merge-rust (lib/runtime/examples)
🔇 Additional comments (2)
.github/workflows/container-validation-dynamo.yml (2)

15-18: Confirm PR docs-only skip won’t violate required-checks.

If this workflow is a required check, skipping it on docs-only PRs can block merges unless branch protection treats “skipped” as passing.

Optionally expand ignores to match push:

   pull_request:
     # Skip docs only changes
     paths-ignore:
       - '**/*.md'
       - '**/*.rst'
+      - '**/*.mdx'
+      - '**/*.ipynb'
+      - 'docs/**'
+      - '**/*.png'
+      - '**/*.svg'

100-100: LGTM (non-functional newline change).

No action needed.

Copy link

@dmitry-tokarev-nv, ⭐3 XP earned, 🏆First Code Review Done completed, 💪Level 9 achieved! [Details]

icon

Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
@rmccorm4 rmccorm4 force-pushed the rmccormick/skip_jobs_on_docs_only branch from c9a6164 to 9c96120 Compare August 29, 2025 18:44
Copy link

@nv-anants, ⭐3 XP earned, 🏆First Code Review Done completed, 💪Level 10 achieved! [Details]

icon

@rmccorm4 rmccorm4 enabled auto-merge (squash) August 29, 2025 18:50
@rmccorm4 rmccorm4 changed the title ci: Skip container jobs on docs changes, only run rust jobs on rust changes ci: Skip gitlab job on docs-only changes, only run rust jobs on rust changes Aug 29, 2025
@rmccorm4 rmccorm4 merged commit a1ca39a into main Aug 29, 2025
16 checks passed
@rmccorm4 rmccorm4 deleted the rmccormick/skip_jobs_on_docs_only branch August 29, 2025 19:15
Copy link

Pull Request Summary by devActivity

Metrics

Cycle Time: 19h 23m Coding Time: < 1 min Pickup Time: 9m Review Time: 19h 13m Comments: 2

Achievements

jasonqinzhou pushed a commit that referenced this pull request Aug 30, 2025
…changes (#2775)

Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
Signed-off-by: Jason Zhou <jasonzho@jasonzho-mlt.client.nvidia.com>
michaelshin pushed a commit that referenced this pull request Sep 2, 2025
…changes (#2775)

Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
Signed-off-by: Michael Shin <michaelshin@users.noreply.github.com>
KrishnanPrash pushed a commit that referenced this pull request Sep 2, 2025
…changes (#2775)

Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
Signed-off-by: Krishnan Prashanth <kprashanth@nvidia.com>
nnshah1 pushed a commit that referenced this pull request Sep 8, 2025
…changes (#2775)

Signed-off-by: Ryan McCormick <rmccormick@nvidia.com>
Signed-off-by: nnshah1 <neelays@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Issues/PRs that reference CI build/test size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants