Skip to content

Add PR QA changelog config, expand pre_merge_checks, inline tools #799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nevil-mathew wants to merge 1 commit into from
Closed

Add PR QA changelog config, expand pre_merge_checks, inline tools #799

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 64 additions & 54 deletions .coderabbit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ language: en-US
tone_instructions: ''
early_access: false
enable_free_tier: true

reviews:
profile: chill
request_changes_workflow: false
Expand All @@ -29,48 +30,50 @@ reviews:
poem: true
labeling_instructions: []

#Exclude non-source code directories from reviews.
# Exclude non-source code directories from reviews
path_filters:
- "!deployment/**"
- "!dev-ops/**"
- "!release-notes/**"
- "!src/api-doc/**"
- "!src/assets/**"
- "!src/configs/**"
- "!src/public/**"
- "!src/temp/**"
- "!**/*.md"
- '!deployment/**'
- '!dev-ops/**'
- '!release-notes/**'
- '!src/api-doc/**'
- '!src/assets/**'
- '!src/configs/**'
- '!src/public/**'
- '!src/temp/**'
- '!**/*.md'

# Add specific review instructions for critical paths.
# Add specific review instructions for critical paths
path_instructions:
- path: "src/services/**"
instructions: "This is core business logic. Please check for correctness, efficiency, and potential edge cases."
- path: "src/controllers/**"
instructions: "These are API controllers. Focus on request/response handling, security (auth middleware usage), and proper status codes."
- path: "src/database/queries/**"
instructions: "Review database queries for performance. Check for N+1 problems and ensure indexes can be used."
- path: "src/validators/**"
instructions: "Validate all incoming data thoroughly. Check for missing or incomplete validation rules."
- path: "src/middlewares/**"
instructions: "This is security-sensitive middleware. Scrutinize for potential vulnerabilities."
- path: 'src/services/**'
instructions: 'This is core business logic. Please check for correctness, efficiency, and potential edge cases.'
- path: 'src/controllers/**'
instructions: 'These are API controllers. Focus on request/response handling, security (auth middleware usage), and proper status codes.'
- path: 'src/database/queries/**'
instructions: 'Review database queries for performance. Check for N+1 problems and ensure indexes can be used.'
- path: 'src/validators/**'
instructions: 'Validate all incoming data thoroughly. Check for missing or incomplete validation rules.'
- path: 'src/middlewares/**'
instructions: 'This is security-sensitive middleware. Scrutinize for potential vulnerabilities.'

abort_on_close: true
disable_cache: false

auto_review:
enabled: true
auto_incremental_review: true
ignore_title_keywords: ["WIP", "skip-review"]
ignore_title_keywords: ['WIP', 'skip-review']
labels: []
drafts: false
# Target reviews to development branches.
# Regular reviews: all PRs into develop
base_branches:
- "develop"
- 'develop'

finishing_touches:
docstrings:
enabled: true
unit_tests:
enabled: true

pre_merge_checks:
docstrings:
mode: warning
Expand All @@ -82,49 +85,55 @@ reviews:
mode: warning
issue_assessment:
mode: warning

tools:
eslint:
enabled: true
semgrep:
enabled: true
dotenvLint:
enabled: true
sqlfluff:
enabled: true
checkov:
enabled: true
gitleaks:
enabled: true
hadolint:
enabled: true
shellcheck:
enabled: true
actionlint:
enabled: true
circleci:
enabled: true
github-checks:
enabled: true
markdownlint:
enabled: true
yamllint:
enabled: true
biome:
enabled: true
languagetool:
enabled: false # optional
eslint: { enabled: true }
semgrep: { enabled: true }
dotenvLint: { enabled: true }
sqlfluff: { enabled: true }
checkov: { enabled: true }
gitleaks: { enabled: true }
hadolint: { enabled: true }
shellcheck: { enabled: true }
actionlint: { enabled: true }
circleci: { enabled: true }
github-checks: { enabled: true }
markdownlint: { enabled: true }
yamllint: { enabled: true }
biome: { enabled: true }
languagetool: { enabled: false }
ast-grep:
essential_rules: true
rule_dirs: []
util_dirs: []
packages: []

# --- NEW: PR-specific changelog generation for staging merges ---
changelog:
enabled: true
base_branches:
- 'develop'
instructions: |
For PRs merging into `staging`, generate a **QA-focused changelog** using only the diff files in this PR:
Comment on lines +111 to +117

@coderabbitai coderabbitai Bot Aug 18, 2025 •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Changelog base_branches mismatches the stated “staging” intent

Header and instructions target “staging merges,” but changelog.base_branches is set to 'develop'. This will trigger the QA changelog on develop PRs, not staging. Align the branch config with the intent.

Option A — staging only:

 changelog:
   enabled: true
   base_branches:
-    - 'develop'
+    - 'staging'
   instructions: |

Option B — support both staging and develop:

 changelog:
   enabled: true
   base_branches:
-    - 'develop'
+    - 'staging'
+    - 'develop'
   instructions: |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# --- NEW: PR-specific changelog generation for staging merges ---
changelog:
enabled: true
base_branches:
- 'develop'
instructions: |
For PRs merging into `staging`, generate a **QA-focused changelog** using only the diff files in this PR:
# --- NEW: PR-specific changelog generation for staging merges ---
changelog:
enabled: true
base_branches:
- 'staging'
instructions: |
For PRs merging into `staging`, generate a **QA-focused changelog** using only the diff files in this PR:
Suggested change
# --- NEW: PR-specific changelog generation for staging merges ---
changelog:
enabled: true
base_branches:
- 'develop'
instructions: |
For PRs merging into `staging`, generate a **QA-focused changelog** using only the diff files in this PR:
# --- NEW: PR-specific changelog generation for staging merges ---
changelog:
enabled: true
base_branches:
- 'staging'
- 'develop'
instructions: |
For PRs merging into `staging`, generate a **QA-focused changelog** using only the diff files in this PR:
🤖 Prompt for AI Agents 
In .coderabbit.yaml around lines 111 to 117, the changelog configuration is
intended for "staging merges" but base_branches is set to 'develop', so the
QA-focused changelog will run on develop PRs instead of staging; update
base_branches to include the intended branch(es) — set it to 'staging' if you
want staging-only, or include both 'staging' and 'develop' if you want support
for both — and ensure the instructions text matches the final branch list.

@nevil-mathew nevil-mathew Aug 18, 2025

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai Does these changes work with coderabbit, if yes please explain how this works, what all changes i need to make.

@coderabbitai coderabbitai Bot Aug 18, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nevil-mathew, the changelog configuration in your .coderabbit.yaml file is not a real CodeRabbit feature. Looking at the current CodeRabbit configuration schema, there is no top-level changelog option supported.

What CodeRabbit Actually Supports

The current CodeRabbit configuration schema includes these main sections:

  • reviews (with walkthrough, summary, and assessment features)
  • chat
  • knowledge_base
  • code_generation
  • Various tools integrations

How to Achieve QA-Focused Changelog Generation

For QA-focused changelog generation, you have these working alternatives:

Option 1: Use high_level_summary feature

reviews:
  high_level_summary: true
  high_level_summary_placeholder: '@coderabbitai summary'
  # This generates summaries in PR descriptions

Option 2: Use path-based instructions for QA focus

reviews:
  path_instructions:
    - path: 'src/services/**'
      instructions: 'Generate detailed QA notes for business logic changes'
    - path: 'src/controllers/**' 
      instructions: 'Highlight API changes and testing requirements for QA'

Option 3: Chat-based changelog generation

You can ask CodeRabbit in PR comments: @coderabbitai generate a QA-focused changelog for this PR

Recommended Changes

  1. Remove the custom changelog section (it has no effect)
  2. Use existing CodeRabbit features like high_level_summary and path_instructions
  3. Fix the base_branches mismatch I mentioned earlier in auto_review.base_branches

Would you like me to help you configure a working solution using CodeRabbit's actual features?

🤔


1. Provide **detailed bullet points** of all changes relevant to QA:
- Updated or new endpoints in `controllers`
- Business logic in `services`
- Database changes (migrations, models, queries)
- Config/constant changes
- Helpers/middlewares
2. End each section with clear action points for QA testing.
3. After the detailed list, write a **compact QA summary (1–2 paragraphs)** suitable for Jira/Slack.
4. Keep changelog strictly PR-specific — do not include unrelated history.

chat:
auto_reply: true
integrations:
jira:
usage: auto
linear:
usage: auto

knowledge_base:
opt_out: false
web_search:
Expand All @@ -144,6 +153,7 @@ knowledge_base:
team_keys: []
pull_requests:
scope: auto

code_generation:
docstrings:
language: en-US
Expand Down