Skip to content

fix(notes): show breaking changes in release-notes templates - #722

Merged
goosewobbler merged 1 commit into
mainfrom
fix/templates-breaking-flag
Oct 23, 2026
Merged

goosewobbler merged 1 commit into
mainfrom
fix/templates-breaking-flag

Conversation

@goosewobbler

@goosewobbler goosewobbler commented Oct 23, 2026 •

Copy link
Copy Markdown
Owner

Description

#720 moved the breaking marker out of the description and into entry.breaking. Templates print only entry.description, so template-rendered notes lost the marker. Only notes' built-in markdown renderer reads the flag. That's why #614's notes still have no Breaking section: this repo renders them with its own template.

  • Repo template (templates/release-notes/release.liquid): breaking entries move out of their category into a Breaking section first, as the built-in renderer does. This works with or without LLM categories.
  • Bundled templates (keep-a-changelog, angular, github-release): each breaking entry is marked - **BREAKING** **scope**: description, the built-in renderer's format.

The templates guide already documents entry.breaking.

Related Issue(s)

None; seen in #614's release-notes preview. Follows #720.

Type of Change

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation change
  • refactor — Code refactoring
  • test — Adding or updating tests
  • chore — Maintenance, dependencies, tooling
  • Breaking change — Requires major version bump

Scope

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release
  • @releasekit/config
  • @releasekit/core
  • CI / workflows
  • Root / monorepo

Checklist

  • Lint passes (pnpm lint)
  • Tests pass (pnpm test)
  • Typecheck passes (pnpm typecheck)
  • Documentation updated (if applicable)
  • Breaking changes noted in description

Testing Notes

🤖 Generated with Claude Code

RetriggerView in GreptileConfidence Score: 5/5

The PR appears safe to merge.

Summary

Restores breaking-change notices in template-rendered release notes.

  • The repo template puts breaking changes in a section before other categories.
  • Bundled templates mark each breaking entry with a visible label.

No actionable issues found. Tests were not run during this review.

Reviews (1) · Last reviewed commit: "fix(notes): show breaking changes in rel..." · Reviewed by Greptile

Templates print entry.description, and since the parser moved the breaking
marker to entry.breaking they lost it. The repo's release-notes template
now moves breaking entries into a Breaking section first, as the built-in
renderer does; the bundled templates mark each breaking entry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Standing release PR: #614 · v0.42.0 queued (4 packages) · open 82d 23h 38m · ✅ ready to merge

Release Preview — v0.41.2 → v0.41.3

Note: Labels on this PR are advisory in standing-pr mode. Bumps come from conventional commits in the standing PR; override by editing labels on the standing PR itself. Add release:immediate to bypass the standing PR and release this PR directly.

These changes will be added to the release PR (#614) when merged:

Changelog

monorepo 0.41.2 → 0.41.3

Fixed

  • show breaking changes in release-notes templates (notes)

All packages → 0.41.3 (sync versioning)

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release

After merge — predicted release

No version escalation — this PR's changes will be included in the queued release without affecting the projected versions.

Package Standing PR This PR After merge
monorepo 0.42.0 0.41.3 0.42.0

Updated automatically by ReleaseKit

@goosewobbler
goosewobbler merged commit 506f37e into main Oct 23, 2026
32 checks passed
@goosewobbler
goosewobbler deleted the fix/templates-breaking-flag branch October 23, 2026 17:50
@github-actions github-actions Bot mentioned this pull request Oct 23, 2026
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.

1 participant