ci: Add config file for CodeRabbit with custom rules#503
Merged
Conversation
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>
Reviewer's GuideAdds 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.yamlsequenceDiagram
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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Documentation: