Skip to content

feat(changelog): Use GitHub alerts in changelog entries as release notes - #985

Merged
BYK merged 1 commit into
masterfrom
feat/changelog-release-notes
Nov 19, 2026
Merged

BYK merged 1 commit into
masterfrom
feat/changelog-release-notes

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

With changelog.policy: auto, a GitHub alert (> [!IMPORTANT] etc.) could not be placed at the top of a release section, because the "Changelog Entry" parser dropped blockquotes.

A top-level GitHub alert in a PR's "Changelog Entry" section is now a release-level note. Craft puts it as-is right under the ## <version> heading, above the AI summary and the categories, so the GitHub release body (findChangeset) gets it too. The changelog preview shows it unquoted while the PR's own entry stays highlighted.

### Changelog Entry

> [!IMPORTANT]
> This release bundles Sentry CLI v3. Self-hosted users need Sentry 24.11.1 or newer.

- Bump Sentry CLI to v3

becomes

## 3.6.0

> [!IMPORTANT]
> This release bundles Sentry CLI v3. Self-hosted users need Sentry 24.11.1 or newer.

### New Features

- Bump Sentry CLI to v3 by @alice in [#123](url)

Behavior details:

  • Notes from several PRs are all kept, newest PR first, the order craft lists entries in. Skipped PRs (label, #skip-changelog, excluded author) and reverted PRs add no notes.
  • A section with only an alert falls back to the PR title as the entry.
  • Only alerts with the marker alone on the first line count, matching GitHub's rendering. Plain blockquotes are still ignored.
  • Alerts nested under a bullet stay out: GitHub doesn't render them in lists anyway.

The changelog docs gain a "Release Notes" item.

Fixes #984 (Option A)

via @BYK.

--

View Session [Sentry]

A GitHub alert (> [!NOTE], > [!IMPORTANT], ...) in a PR's Changelog Entry
section was dropped. It now goes as-is right under the version heading,
above the categories, so it also reaches the GitHub release body and the
changelog preview.

Fixes #984

Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
@github-actions

github-actions Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-11-19 18:18 UTC

@BYK BYK 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.

LGTM

@lucas-zimerman - does this address your request?

@sentry-junior
sentry-junior Bot marked this pull request as ready for review November 18, 2026 15:50
@sentry-junior
sentry-junior Bot requested a review from BYK November 18, 2026 15:50
@BYK
BYK merged commit a654011 into master Nov 19, 2026
29 checks passed
@BYK
BYK deleted the feat/changelog-release-notes branch November 19, 2026 18:18
@lucas-zimerman

Copy link
Copy Markdown

It does, thank you!

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.

Support release-level callouts (GitHub alerts) in auto changelogs

2 participants