update coderabbit config#514
Conversation
📝 WalkthroughWalkthroughUpdated code review configuration in .coderabbit.yaml: disabled high-level walkthrough summaries and added a path filter to exclude the .github directory from reviews. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.coderabbit.yaml(2 hunks)
🔇 Additional comments (1)
.coderabbit.yaml (1)
28-28: Clarify .coderabbit.yamlpath_filtersto avoid accidentally skipping.githubThe semantics of Coderabbit’s
path_filtersaren’t confirmed—some systems treat an exclude-only list as “include everything except these,” while others require an explicit include and will select nothing if none is given. To avoid unintended gaps (e.g., hiding workflows or makingtools.actionlinta no-op), update your filter or verify its behavior:• Location to update:
.coderabbit.yaml, line 28# current (ambiguous) path_filters: ["!.github/**"]• Recommended explicit filter:
path_filters: include: - "**" exclude: - ".github/**"• If you still want workflows linted but skip other
.githubfiles, test and confirm with:path_filters: include: - "**" - ".github/workflows/**" exclude: - ".github/**"or disable actionlint entirely if you truly skip
.github:tools: actionlint: enabled: false• How to verify locally before merging:
– git ls-files | grep -vE '^(.github/)'
– Simple Python/glob script to simulate your include/exclude patternsPlease choose your desired behavior and either make the include–exclude patterns explicit or run a dry-run to confirm that workflows remain in scope.
| high_level_summary: true | ||
| high_level_summary_placeholder: '@coderabbitai summary' | ||
| high_level_summary_in_walkthrough: true | ||
| high_level_summary_in_walkthrough: false |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Walkthrough summary disabled: OK, ensure PR description still gets a summary.
With high_level_summary_in_walkthrough: false, the walkthrough won’t include the summary. Because the PR description is currently empty, please confirm your PR template includes the placeholder @coderabbitai summary so the high-level summary is injected there. Otherwise, enable pre-merge checks to enforce non-empty titles/descriptions.
You can enforce this with pre-merge checks (add under reviews:):
pre_merge_checks:
title:
mode: error
requirements: "Concise, descriptive, ideally under 60 characters."
description:
mode: error🏁 Script executed:
#!/bin/bash
set -e
echo "---- .coderabbit.yaml (first 50 lines) ----"
sed -n '1,50p' .coderabbit.yaml || echo ".coderabbit.yaml not found"
echo
echo "---- Looking for PR template files ----"
rg -l "pull_request_template" -g "*.md" || echo "No PR template file found"
echo
echo "---- Searching for '@coderabbitai summary' placeholder ----"
grep -R "@coderabbitai summary" -n . || echo "No '@coderabbitai summary' placeholder found"Length of output: 1893
No PR template found: add the summary placeholder or enforce description checks
The repo contains high_level_summary_in_walkthrough: false and a high_level_summary_placeholder: '@coderabbitai summary' in .coderabbit.yaml, but no PR template file was detected to host that placeholder. To ensure your high-level summary isn’t lost:
• Add/update a PULL_REQUEST_TEMPLATE.md (or equivalent) in your repo’s .github/ (or docs) directory with the line:
@coderabbitai summary
• Alternatively (or in addition), enforce non-empty PR descriptions via pre-merge checks under reviews: in .coderabbit.yaml:
reviews:
…
pre_merge_checks:
title:
mode: error
requirements: "Concise, descriptive, ideally under 60 characters."
description:
mode: error🤖 Prompt for AI Agents
In .coderabbit.yaml around line 10, the repo has
high_level_summary_in_walkthrough: false and a high_level_summary_placeholder
configured but no PR template to host that placeholder; either add a
PULL_REQUEST_TEMPLATE.md (or equivalent under .github/ or docs/) containing the
exact placeholder line @coderabbitai summary so PRs get the summary inserted, or
update .coderabbit.yaml reviews.pre_merge_checks to enforce non-empty
descriptions (set description.mode: error and optionally title requirements) so
missing PR descriptions block merges; implement one or both changes and commit
the new template or the updated pre_merge_checks section.
|
The following are automatically added/executed:
Available user actions:
Supported labels{'/lgtm', '/hold', '/cherry-pick', '/build-push-pr-image', '/verified', '/wip'} |
|
Status of building tag latest: success. |
4 participants
Description
How Has This Been Tested?
Merge criteria:
Summary by CodeRabbit