ci: Add config file for CodeRabbit with custom rules#312
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 conventions and review rules for Ansible roles, tests, templates, variables, Python code, and PR metadata. 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:
- Several path-specific instructions in
.coderabbit.yaml(e.g.,kernel_settings_*variables,system_role:kernel_settingsfingerprint,__kernel_settings_is_ostree) appear tightly coupled to thekernel_settingsrole; if this repo is for a different role, consider parameterizing or generalizing these to avoid misleading or incorrect guidance. - The test playbook instructions hardcode the use of
tasks/run_role_with_clear_facts.ymland a specific invocation pattern; double-check that this wrapper and naming convention exist in this repository to prevent CodeRabbit from repeatedly flagging valid role invocation patterns as violations.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Several path-specific instructions in `.coderabbit.yaml` (e.g., `kernel_settings_*` variables, `system_role:kernel_settings` fingerprint, `__kernel_settings_is_ostree`) appear tightly coupled to the `kernel_settings` role; if this repo is for a different role, consider parameterizing or generalizing these to avoid misleading or incorrect guidance.
- The test playbook instructions hardcode the use of `tasks/run_role_with_clear_facts.yml` and a specific invocation pattern; double-check that this wrapper and naming convention exist in this repository to prevent CodeRabbit from repeatedly flagging valid role invocation patterns as violations.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
Add CodeRabbit configuration to enforce repository-specific contribution and review conventions.
CI:
Documentation: