chore: Add CodeRabbit settings file to disable auto-review.

[kirkrodrigues]

Description

The way we develop in this repo has a few characteristics that make it unsuitable for CodeRabbit's automatic reviews:

1. We tend to build up a sequence of interdependent PRs (C -> B -> A), so CodeRabbit may end up reviewing several unrelated changes from PRs A & B in PR C.
2. We tend to push frequently to this repo which can trigger CodeRabbit's rate limits.

Thus, this PR adds a settings file for CodeRabbit that mirrors our organization settings but with automatic reviews disabled.

Note

This means developers (or maintainers) will need to manually invoke CodeRabbit using @coderabbitai review.

For readability, I broke up the settings file into sections, but note that these sections are defined by me and not reflected anywhere in CodeRabbit's docs.

Checklist

• The PR satisfies the contribution guidelines.
• This is a breaking change and that has been indicated in the PR title, OR this isn't a
  breaking change.
• Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Validated that CodeRabbit didn't automatically review this PR until invoked by the command in the PR description.

Summary by CodeRabbit

• New Features
  • Introduced a new configuration that enhances chat integration with improved auto-reply functionality, external tool integration, automated review options, and refined knowledge base settings.
• Chores
  • Updated automated quality checks to incorporate the new configuration, ensuring consistent validation across all settings.

[coderabbitai]

Walkthrough

This pull request adds a new configuration file, .coderabbit.yaml, which defines settings for a chat integration system. The file contains configurations for auto-reply, integrations (such as Linear and Jira), knowledge base parameters, review process settings, and tool configurations. In addition, lint-tasks.yml has been updated to include .coderabbit.yaml in the yamllint check.

Changes

File(s)	Change Summary
.coderabbit.yaml	New configuration file added with settings for chat integration, including auto-reply, integrations, knowledge base, reviews, and tool specifications.
lint-tasks.yml	Updated task configuration to include .coderabbit.yaml in the list of files processed by the yamllint command.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
• @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.

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.

[kirkrodrigues]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.coderabbit.yaml (1)

52-58: Per-Path Instructions

The per-path settings provide clear guidance on code style by suggesting that developers use false == <expression> instead of !<expression>. This level of detail aids in enforcing a consistent coding style across various file types.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6ed113a and 4f846db.

📒 Files selected for processing (2)

• .coderabbit.yaml (1 hunks)
• lint-tasks.yml (1 hunks)

🔇 Additional comments (10)

lint-tasks.yml (1)

47-57: Inclusivity of .coderabbit.yaml in the linting process

The addition of .coderabbit.yaml to the yamllint command ensures that the new configuration file is validated for proper YAML syntax. This change helps maintain consistency across configuration files in the repository.

.coderabbit.yaml (9)

1-9: Schema and Chat Integration Settings

The schema declaration on line 1 correctly points to the CodeRabbit settings schema. The chat integration section is configured with auto_reply: true and both Linear and Jira integrations set to "auto". Verify that these settings meet your intended behaviour—specifically, if the objective is to disable auto-review without impacting automatic chat replies.

---

11-15: General Settings Validity

The general settings are straightforward and conform to the expected schema. The values for early_access, enable_free_tier, language, and tone_instructions appear to be correctly set.

---

16-32: Knowledge Base Configuration

The knowledge base section is well-configured with appropriate scopes for issues, learnings, pull requests, and web search functionalities. The settings adhere to the schema and provide clear guidelines for data retention and integration usage.

---

33-44: Auto-Review Disabled as Intended

Within the reviews configuration, the auto_review sub-section shows enabled: false and auto_incremental_review: false, which directly supports the PR objective to disable automatic reviews. This ensures that CodeRabbit will not auto-review changes unless manually invoked with @coderabbitai review.

---

45-50: Finishing Touches and Miscellaneous Settings

The finishing touches settings, such as enabling docstrings and setting the review profile to "chill", are configured appropriately. These settings enhance the readability and consistency of reviews.

---

59-63: Review Status Settings

The review status settings—including commit_status, fail_commit_status, and review_status—are correctly defined. These settings will enable effective integration with your CI/CD pipelines and status reporting mechanisms.

---

64-72: Summary Generation and Related Settings

The configuration for summary generation, label suggestions, and related issues/PRs is comprehensive and well structured. These settings will help to provide valuable context during the review process.

---

79-82: Title Generation Settings

The title generation settings, such as auto_title_placeholder and auto_title_instructions, are clearly defined. They should ensure consistent and meaningful pull request titles.

---

83-143: Tool Integrations Settings

The extensive tools section includes configurations for various linters and code analysis utilities. Each tool is enabled as per the schema defaults, and the settings (e.g., timeouts, configuration file paths) appear correct. This thorough configuration should facilitate robust code review and integration checks.