CodeRabbit writes a summary into every PR description and keeps it updated on each push. The PR title and description become the squash commit message, so the block is in every squash message unless whoever merges cuts it out. In a breaking PR it can also end up after the BREAKING CHANGE: footer: on #1317 it was appended below the footer and stayed there until the author moved it. CONTRIBUTING.md requires that footer to be last, because semantic-release publishes everything after it as the release note, and .releaserc.mjs's stripTrailers only removes Key: value trailers, so it cannot strip the block.
Release notes have stayed clean so far — none of the 44 breaking entries in CHANGELOG.md contains CodeRabbit text — because the block has been trimmed at merge time. substrait-io/substrait#1222 fixed the same thing in the spec repo with a .coderabbit.yaml that moves the summary into CodeRabbit's walkthrough comment:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
reviews:
high_level_summary_in_walkthrough: true
This repo has no .coderabbit.yaml yet.
CodeRabbit writes a summary into every PR description and keeps it updated on each push. The PR title and description become the squash commit message, so the block is in every squash message unless whoever merges cuts it out. In a breaking PR it can also end up after the
BREAKING CHANGE:footer: on #1317 it was appended below the footer and stayed there until the author moved it.CONTRIBUTING.mdrequires that footer to be last, because semantic-release publishes everything after it as the release note, and.releaserc.mjs'sstripTrailersonly removesKey: valuetrailers, so it cannot strip the block.Release notes have stayed clean so far — none of the 44 breaking entries in
CHANGELOG.mdcontains CodeRabbit text — because the block has been trimmed at merge time. substrait-io/substrait#1222 fixed the same thing in the spec repo with a.coderabbit.yamlthat moves the summary into CodeRabbit's walkthrough comment:This repo has no
.coderabbit.yamlyet.