ci: do not run CI workflow if the changes are related only to documentation or GitHub Actions configuration

[martin-georgiev]

Summary by CodeRabbit

• Chores
  • Streamlined the automated workflow to trigger only on impactful changes, reducing unnecessary process runs.

[coderabbitai]

Walkthrough

The CI workflow configuration has been updated by adding paths-ignore clauses for both the pull_request and push events. These clauses exclude files in the .github directory and any Markdown files, ensuring that modifications to these files do not trigger the CI workflow. No other parts of the configuration or public declarations were modified.

Changes

File	Summary
.github/workflows/ci.yml	Added paths-ignore for both pull_request and push events to exclude .github and Markdown files.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub Actions
    participant CI as CI Workflow
    Dev->>GH: Push commit or Open Pull Request
    GH-->>CI: Evaluate changed file paths
    alt Changes outside ignored paths
        CI->>CI: Run workflow
    else Changes in `.github` or Markdown files
        CI-->>Dev: Skip workflow trigger
    end

Loading

Poem

I'm just a rabbit, quick and keen,
Leaping 'round files behind the scene.
.github and Markdown, I gracefully bypass,
Allowing CI to run—no triggers amass.
Hopping in harmony, I cheer this clean act!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fa59d6b and 655dfcf.

📒 Files selected for processing (1)

• .github/workflows/ci.yml (1 hunks)

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

• GitHub Check: sloth

🔇 Additional comments (2)

.github/workflows/ci.yml (2)

6-8: Added paths-ignore for Pull Request events.
The update correctly adds a paths-ignore clause under the pull_request event to exclude changes in the .github/** directory and all Markdown files, ensuring that CI isn’t triggered for documentation or configuration updates.

---

10-13: Added paths-ignore for Push events.
The configuration now properly includes a paths-ignore clause under the push event with the same exclusion rules, aligning with the objective of not triggering the CI workflow for non-code changes.

---

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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

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.