ci: Add config file for CodeRabbit with custom rules#351
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 new .coderabbit.yaml configuration file to integrate CodeRabbit code review automation with this repository, encoding project-specific review rules, conventions, and path-based instructions for Ansible roles, tests, templates, variables, Python code, and documentation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The
.coderabbit.yamlembeds quite a lot of detailed, role-specific guidance (e.g., around timesync variables and test patterns); consider replacing some of the longer normative sections with links or short references to the canonical contributor docs to reduce the risk of them drifting out of sync. - Several instructions talk about enforcing test and documentation requirements (e.g., in
tasks/**/*.ymlanddefaults/**/*.yml), which may be better expressed as warnings or suggestions in the wording so that CodeRabbit feedback doesn’t conflict with existing review policies when exceptions are needed.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `.coderabbit.yaml` embeds quite a lot of detailed, role-specific guidance (e.g., around timesync variables and test patterns); consider replacing some of the longer normative sections with links or short references to the canonical contributor docs to reduce the risk of them drifting out of sync.
- Several instructions talk about enforcing test and documentation requirements (e.g., in `tasks/**/*.yml` and `defaults/**/*.yml`), which may be better expressed as warnings or suggestions in the wording so that CodeRabbit feedback doesn’t conflict with existing review policies when exceptions are needed.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
CI: