fix(release): changelog renderer should prefer breaking change explanation text #20798
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 001c532. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 6 targets
Sent with 💌 from NxCloud. |
JamesHenry
commented
Dec 15, 2023
| (commit.isBreaking ? '⚠️ ' : '') + | ||
| (commit.scope ? `**${commit.scope.trim()}:** ` : '') + |
There was a problem hiding this comment.
Moved these around it looks better when they line up.
Real example of the "after" of this PR from rxjs repo:
AgentEnder
approved these changes
Dec 17, 2023
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Current Behavior
We always repeat the breaking change commit message and do not recognize breaking changes without the
!being present.Expected Behavior
We recognize breaking changes with only
BREAKING CHANGE:present (in accordance with the spec https://www.conventionalcommits.org/en/v1.0.0/), and we preferentially render the explanation text afterBREAKING CHANGE:in the relevant section of the changelog.Related Issue(s)
Fixes #