Repository navigation
fix(notes): show breaking changes in release-notes templates - #722
Merged
Merged
Conversation
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>
7 of 20 tasks
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
These changes will be added to the release PR (#614) when merged: Changelogmonorepo 0.41.2 → 0.41.3
After merge — predicted release
Updated automatically by ReleaseKit |
Merged
62 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
#720 moved the breaking marker out of the description and into
entry.breaking. Templates print onlyentry.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.templates/release-notes/release.liquid): breaking entries move out of their category into aBreakingsection first, as the built-in renderer does. This works with or without LLM categories.- **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 featurefix— Bug fixdocs— Documentation changerefactor— Code refactoringtest— Adding or updating testschore— Maintenance, dependencies, toolingScope
@releasekit/version@releasekit/notes@releasekit/publish@releasekit/release@releasekit/config@releasekit/coreChecklist
pnpm lint)pnpm test)pnpm typecheck)Testing Notes
--no-llm: a Breaking section lists the five breaking changes (fix(publish)!: apply schema publish defaults when the config has no publish block #690, fix(core)!: report each error's exit-code family as its envelope category #708, fix(version)!: default to conventionalcommits and reject unsupported presets #694, feat(cli)!: envelope the version and publish commands, unwrap on the pipe #616, fix(version)!: sync every committed Cargo.lock that records a bumped crate #674), followed by New, Fixed and Changed. All 53 entries are present.🤖 Generated with Claude Code


Confidence Score: 5/5
The PR appears safe to merge.Summary
Restores breaking-change notices in template-rendered release notes.
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