ci: Add config file for CodeRabbit with custom rules#209
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 centralized CodeRabbit configuration file (.coderabbit.yaml) to enforce linux-system-roles contribution conventions and customize automated review behavior for this repository, including PR metadata checks and path-specific review instructions for Ansible tasks, tests, templates, variables, Python, and documentation. Flow diagram for CodeRabbit PR review with .coderabbit.yamlflowchart TD
Developer[Developer opens PR] --> GitHub[GitHub PR]
GitHub --> CodeRabbit[CodeRabbit review bot]
CodeRabbit --> Config[Load .coderabbit.yaml]
Config --> PreMergeChecks[Apply pre_merge_checks]
PreMergeChecks --> TitleCheck[Validate PR title format]
PreMergeChecks --> DescriptionCheck[Check description template]
Config --> PathInstructions[Apply path_instructions]
PathInstructions --> AnsibleTasks[tasks/**/*.yml rules]
PathInstructions --> Tests[tests/tests_*.yml rules]
PathInstructions --> Templates[templates/**/*.j2 rules]
PathInstructions --> Defaults[defaults/**/*.yml rules]
PathInstructions --> Vars[vars/**/*.yml rules]
PathInstructions --> Python[**/*.py rules]
PathInstructions --> Docs[README.md rules]
CodeRabbit --> ReviewOutput[Post review comments with warnings]
ReviewOutput --> Developer
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 instructions are hard-coded to the example "template" role (e.g.,
template_/__template_prefixes,system_role:templatefingerprint,template_secure_logging,__template_packages,__template_is_ostree), which may not align with other linux-system-roles; consider parameterizing or generalizing this config so it applies correctly across different roles. - The rules reference specific files and paths like
.commitlintrc.js,.github/pull_request_template.md,vars/main.yml,defaults/main.yml,tasks/run_role_with_clear_facts.yml, andtests/tests_*.yml; please double-check that these exist or are consistently named in all repositories where this centralized.coderabbit.yamlwill be used to avoid false warnings.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Several instructions are hard-coded to the example "template" role (e.g., `template_` / `__template_` prefixes, `system_role:template` fingerprint, `template_secure_logging`, `__template_packages`, `__template_is_ostree`), which may not align with other linux-system-roles; consider parameterizing or generalizing this config so it applies correctly across different roles.
- The rules reference specific files and paths like `.commitlintrc.js`, `.github/pull_request_template.md`, `vars/main.yml`, `defaults/main.yml`, `tasks/run_role_with_clear_facts.yml`, and `tests/tests_*.yml`; please double-check that these exist or are consistently named in all repositories where this centralized `.coderabbit.yaml` will be used to avoid false warnings.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
Chores: