Skip to content

changelog: parse release-drafter notes with - bullets and ## headers#3536

Open
cotti wants to merge 1 commit into
mainfrom
fix/release-note-parser-formats
Open

changelog: parse release-drafter notes with - bullets and ## headers#3536
cotti wants to merge 1 commit into
mainfrom
fix/release-note-parser-formats

Conversation

@cotti

@cotti cotti commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Why

changelog gh-release derives changelog entries from a GitHub release's body, but ReleaseNoteParser only recognized:

  • * bullets (asterisk), and
  • ### section headers.

That doesn't match the default release-drafter output — nor what docs-builder itself emits — which uses - bullets (- <title> by @<author> in #<n>) and level-2 (##) emoji headers. As a result the format was detected as Unknown, zero PR references were extracted, and the produced bundle was empty.

Found while dogfooding the changelog CDN flow on docs-builder's own 1.18.1 release:

Detected format: Unknown, found 0 PR references
→ No PR references found in release notes. No changelogs will be created.

What

  • PrLineRegex: accept both * and - bullets (^[*-]\s+…).
  • SectionHeaderRegex: accept headers at level 2 or deeper (^#{2,}\s+…).
  • Format detection (HasEmojiSectionHeaders): trigger on ## rather than requiring ###.
  • New ReleaseNoteParserTests covering the docs-builder format, plus regressions for the legacy (###/*) and GitHub-default shapes.

After the fix, the same release parses as:

Detected format: ReleaseDrafter, found 3 PR references
Inferred lifecycle: ga, target version: 1.18.1

Test plan

  • dotnet test tests/Elastic.Changelog.Tests (746 passed, incl. 6 new)
  • ./build.sh build --skip-dirty-check (lint + compile clean)
  • Native AOT publish clean (no trim/AOT warnings)
  • End-to-end changelog gh-release docs-builder 1.18.1 now detects ReleaseDrafter + 3 PRs

Made with Cursor

ReleaseNoteParser only matched `*` bullets and `###` section headers, so it
failed on release-drafter output that uses `-` bullets (GitHub-style
`- <title> by @<author> in #<n>`) and level-2 (`##`) emoji headers. This is the
default release-drafter shape and what docs-builder itself emits, so
`changelog gh-release` detected the format as Unknown, extracted zero PRs, and
produced empty bundles.

Accept both `*`/`-` bullets and section headers at level 2 or deeper, and detect
the release-drafter format on `##` headers. Adds ReleaseNoteParser unit tests
for the docs-builder format plus regressions for the legacy (`###`/`*`) and
GitHub-default shapes.

Co-authored-by: Cursor <cursoragent@cursor.com>
@cotti cotti requested a review from a team as a code owner June 19, 2026 14:01
@cotti cotti requested a review from technige June 19, 2026 14:01
@cotti cotti added the fix label Jun 19, 2026
@cotti cotti temporarily deployed to integration-tests June 19, 2026 14:01 — with GitHub Actions Inactive
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@cotti, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 23 minutes and 24 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 83029d92-d084-4866-8cbe-15117a2af23f

📥 Commits

Reviewing files that changed from the base of the PR and between 654fcce and c6c2fd9.

📒 Files selected for processing (2)
  • src/services/Elastic.Changelog/GitHub/ReleaseNoteParser.cs
  • tests/Elastic.Changelog.Tests/ReleaseNoteParserTests.cs
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch fix/release-note-parser-formats

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 and usage tips.

@Mpdreamz Mpdreamz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants