Skip to content

chore: add a .coderabbit.yaml that keeps CodeRabbit's summary out of the PR description - #1343

Merged
andrew-coleman merged 1 commit into
substrait-io:mainfrom
nielspardon:chore/coderabbit-config
Sep 30, 2026
Merged

andrew-coleman merged 1 commit into
substrait-io:mainfrom
nielspardon:chore/coderabbit-config

Conversation

@nielspardon

@nielspardon nielspardon commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

CodeRabbit writes its high-level summary into every PR description, which becomes the squash commit message. In a breaking PR the block can land after the BREAKING CHANGE: footer, where semantic-release would publish it as part of the release note; stripTrailers in .releaserc.mjs only removes Key: value trailers and cannot strip it.

This moves the summary into CodeRabbit's walkthrough comment instead, the same setting substrait-io/substrait#1222 applied to the spec repo.

Closes #1340

🤖 Generated with AI

Summary by CodeRabbit

  • New Features
    • Review walkthroughs now include a high-level summary, making key changes easier to scan before reading the full review. The summary appears alongside the existing walkthrough content and provides a concise overview of the changes.

…the PR description

CodeRabbit writes its high-level summary into every PR description,
which becomes the squash commit message. In a breaking PR the block
can land after the BREAKING CHANGE: footer, where semantic-release
would publish it as part of the release note; stripTrailers in
.releaserc.mjs only removes Key: value trailers and cannot strip it.

Move the summary into CodeRabbit's walkthrough comment instead, as
substrait-io/substrait#1222 did for the spec repo.

Closes substrait-io#1340
@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

This pull request changes a CodeRabbit configuration file. Because it comes from a fork or its author is not a repository collaborator, reviews use only the configuration from the target branch. The proposed configuration will take effect after it is merged.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 813c09eb-05cf-49fb-aa90-da048c0d9d23

📥 Commits

Reviewing files that changed from the base of the PR and between 3a6c248 and 872565f.

📒 Files selected for processing (1)
  • .coderabbit.yaml

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.


📝 Walkthrough

Walkthrough

The CodeRabbit configuration now declares the v2 JSON schema and enables high-level summaries in review walkthroughs.

Changes

Walkthrough summary configuration

Layer / File(s) Summary
Configure walkthrough summaries
.coderabbit.yaml
The configuration declares the v2 JSON schema and enables high-level summaries in review walkthroughs.

Priority: ➖ Normal

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to 87256

The summary will appear in the walkthrough rather than the PR description, matching the stated objective; no actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 87256

The changed surface does not map to a changed system, dependency edge, entrypoint, or external dependency.

Changed systems: None identified.

Architecture concerns
No architecture-level concerns identified.

Review details

Before / after behavior

  • observed — Modified behavior in .coderabbit.yaml: Adds the v2 schema reference and enables high-level summaries in review walkthroughs.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding .coderabbit.yaml to keep CodeRabbit's summary out of the PR description. The chore: Conventional Commit type is appropriate.
Description check ✅ Passed The description explains the rationale, expected behavior, release-note risk, related precedent, and linked issue. It satisfies the repository template requirements.
Linked Issues check ✅ Passed The PR adds .coderabbit.yaml with the v2 schema declaration and reviews.high_level_summary_in_walkthrough: true. This implements the configuration required by issue #1340 and moves the high-level …
Out of Scope Changes check ✅ Passed The change adds only .coderabbit.yaml. The file directly implements issue #1340, and the summary reports no unrelated source or public API changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

andrew-coleman pushed a commit to substrait-io/substrait-python that referenced this pull request Sep 30, 2026
CodeRabbit writes its high-level summary into every PR description,
which becomes the squash commit message, so the block ends up in every
squash commit unless it is cut out at merge time. In a breaking PR it
can also land after the `BREAKING CHANGE:` footer, where
semantic-release publishes it as part of the release note.

This moves the summary into CodeRabbit's walkthrough comment instead,
the same setting substrait-io/substrait#1222 applied to the spec repo
and substrait-io/substrait-java#1343 applies there.

🤖 Generated with AI

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Improvements**
  * Code review walkthroughs now include a high-level summary.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
andrew-coleman pushed a commit to substrait-io/substrait-validator that referenced this pull request Sep 30, 2026
CodeRabbit writes its high-level summary into every PR description,
which becomes the squash commit message, so the block ends up in every
squash commit unless it is cut out at merge time.

This moves the summary into CodeRabbit's walkthrough comment instead,
the same setting substrait-io/substrait#1222 applied to the spec repo
and substrait-io/substrait-java#1343 applies there.

🤖 Generated with AI

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Chores**
* Updated automated review settings to include a high-level summary in
review walkthroughs. This change affects how reviews are presented and
does not alter product functionality or the end-user experience. No
other user-facing changes are included in this update.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@andrew-coleman
andrew-coleman merged commit ca3a847 into substrait-io:main Sep 30, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: add a .coderabbit.yaml that keeps CodeRabbit's summary out of the PR description

2 participants