Skip to content

ci: Add config file for CodeRabbit with custom rules#503

Merged
spetrosi merged 1 commit into
mainfrom
coderabbit-init
May 19, 2026
Merged

ci: Add config file for CodeRabbit with custom rules#503
spetrosi merged 1 commit into
mainfrom
coderabbit-init

Conversation

@spetrosi

@spetrosi spetrosi commented May 19, 2026

Copy link
Copy Markdown
Contributor

Sourcery that we currently use cannot read documentation files and best
practices, it's rather a refactoring tool.
So I want to introduce CodeRabbit that allows creating .coderabbit.yaml with
custom rules and conventions.

Signed-off-by: Sergei Petrosian spetrosi@redhat.com

Summary by Sourcery

Add a CodeRabbit configuration file defining review behavior and project-specific conventions.

CI:

  • Configure CodeRabbit code review settings, disabling nonessential features and enabling PR title/description checks with project-specific rules.

Documentation:

  • Document expected conventions and requirements for tasks, handlers, tests, templates, variables, Python code, and README updates via the CodeRabbit configuration guidance.

Sourcery that we currently use cannot read documentation files and best
practices, it's rather a refactoring tool.
So I want to introduce CodeRabbit that allows creating .coderabbit.yaml with
custom rules and conventions.

Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
@spetrosi spetrosi self-assigned this May 19, 2026
@sourcery-ai

sourcery-ai Bot commented May 19, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds a .coderabbit.yaml configuration file to integrate CodeRabbit code review automation with repository-specific conventions, disabling non-essential features and encoding detailed, path-based review rules for Ansible roles, tests, templates, variables, Python code, and documentation.

Sequence diagram for CodeRabbit review using .coderabbit.yaml

sequenceDiagram
  actor Developer
  participant GitHub
  participant CodeRabbit
  participant Repo

  Developer->>GitHub: Open_pull_request
  GitHub-->>Repo: Store_PR_and_diff
  GitHub->>CodeRabbit: Trigger_review_webhook
  CodeRabbit-->>Repo: Read_.coderabbit_yaml
  CodeRabbit->>CodeRabbit: Apply_pre_merge_checks_title
  CodeRabbit->>CodeRabbit: Apply_custom_checks_description
  CodeRabbit->>CodeRabbit: Apply_path_instructions
  CodeRabbit-->>GitHub: Post_review_comments_and_warnings
  GitHub-->>Developer: Display_CodeRabbit_review
Loading

File-Level Changes

Change Details Files
Introduce CodeRabbit review configuration and disable non-essential automated features.
  • Add .coderabbit.yaml with top-level chat and reviews settings
  • Disable entertainment features like poems and fortunes
  • Turn off auto behaviors such as auto labels, auto reviewer assignment, and automatic request-changes workflows
  • Disable additional review extras like sequence diagrams, effort estimation, suggested labels, and high-level summaries
  • Disable finishing-touches unit test suggestions
.coderabbit.yaml
Enforce PR metadata standards via pre-merge checks.
  • Configure PR title checks using Conventional Commits format with warning severity
  • Add custom description-format check enforcing repository PR template sections (Feature/Enhancement, Reason, Result, optional Issue Tracker)
.coderabbit.yaml
Define path-specific review instructions encoding linux-system-roles conventions.
  • Add detailed Ansible tasks guidance for no_log usage, OSTree-compatible package installation, module usage, idempotency, check-mode support, and required tests
  • Specify handler rules for sensitive data logging
  • Define strict test playbook patterns using include_tasks wrapper and quality expectations
  • Enforce template headers for Jinja2 templates
  • Define naming/location rules for user-facing defaults and internal vars, plus documentation requirements for new variables
  • Add Python style expectations (PEP8, Black, tox checks)
  • Add README requirements to document new user-facing variables and usage examples
.coderabbit.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@spetrosi spetrosi merged commit c7cc64a into main May 19, 2026
33 checks passed
@spetrosi spetrosi deleted the coderabbit-init branch May 19, 2026 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant