Updating workflows to run only on code changes

[pavangudiwada]

Fixes #510.

[coderabbitai]

Walkthrough

The workflow configurations for GitHub Actions were updated to refine their trigger conditions. Both the build-and-test and LLM evaluation workflows now ignore documentation and metadata file changes, and only trigger on specific pull request event types. These changes aim to restrict workflow runs to relevant code or test modifications.

Changes

File(s)	Change Summary
.github/workflows/build-and-test.yaml	Refined workflow triggers: ignores docs/metadata changes; restricts PR events triggering the workflow.
.github/workflows/llm-evaluation.yaml	Similar refinement: ignores docs/metadata changes; limits PR event types for workflow execution.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub
    participant Workflow

    Developer->>GitHub: Push or PR event
    GitHub->>Workflow: Check event type and file changes
    alt Relevant code/test change & allowed event type
        Workflow->>Workflow: Run workflow jobs
    else Only docs/metadata changed or disallowed PR event
        Workflow-->>GitHub: Do not run workflow
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Restrict workflows to ignore docs/metadata-only changes and unnecessary PR event triggers (#510)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai 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:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

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

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

.github/workflows/llm-evaluation.yaml (2)

6-13: Refine pull_request triggers and ignore patterns
Restricts runs to only opened, synchronize, reopened, and ready_for_review events and ignores Markdown, docs, and key metadata.

Nit: The patterns '*.md' and '**/*.md' overlap; you can drop the root-level *.md since **/*.md covers the same scope.

---

16-22: Optimize push trigger exclusions
Skips workflow runs on non-code changes by ignoring docs, Markdown, and metadata files.

Nit: Similarly, '*.md' is redundant given '**/*.md'; consider consolidating.

.github/workflows/build-and-test.yaml (2)

5-13: Exclude documentation and metadata on push
The updated paths-ignore prevents CI runs for docs and Markdown updates, focusing on actual code changes.

Nit: You can simplify by removing '*.md', relying solely on '**/*.md'.

---

15-22: Align pull_request triggers with evaluation workflow
Using specific event types and identical ignore patterns maintains consistency and reduces redundant pipeline executions.

Nit: As above, drop the root-level *.md entry in favor of **/*.md to minimize duplication.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2cf1465 and f5ed7b2.

📒 Files selected for processing (2)

• .github/workflows/build-and-test.yaml (1 hunks)
• .github/workflows/llm-evaluation.yaml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: build (3.11)
• GitHub Check: build (3.12)
• GitHub Check: build (3.10)
• GitHub Check: build (3.12)