feat(default-changelog): add a separate formatted breaking changes section #1110
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
codejedi365
force-pushed
the
feat/add-breaking-changes-summary-to-changelog
branch
10 times, most recently
from
900c1c1 to
fcd8bfb
Compare
…cturedText template Resolves: python-semantic-release#244
…own changelog template
…ructuredText template
codejedi365
force-pushed
the
feat/add-breaking-changes-summary-to-changelog
branch
from
fcd8bfb to
b0d0deb
Compare
codejedi365
deleted the
feat/add-breaking-changes-summary-to-changelog
branch
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.
Purpose
Rationale
This is more of a stepping stone to the next phase where we will drop the need to display the entire commit in the changelog. The Breaking change descriptions are one of the items we didn't display normally even though it was parsed.
How did you test?
I updated the git repo changelog generator for the E2E scenarios which means the E2E tests that validate changelogs have the correct breaking change summaries included.
I also updated the release notes and changelog template test cases to separate out the breaking change descriptions into their own section and validate the template provides the accurate result.
How to Verify