fix: preserve markdown list formatting in changelog output#23
Merged
Conversation
When changeset descriptions use markdown list syntax (- item), the formatter was wrapping each entry in another - prefix, creating nested lists (- - item) that render poorly on GitHub. Now detects when the body already starts with "- " and preserves it. Subsequent lines starting with "- " are also kept as top-level bullets instead of being indented as continuations.
🦋 Changeset detectedLatest commit: 5f7e8c8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Merged
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
1 participant
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.
Summary
When changeset descriptions use markdown list syntax (
- item), the formatter wraps each entry in another-prefix, creating nested lists (- - item) that render as double-indented bullets on GitHub.Before:
After:
Two changes in
getReleaseLine:firstLinealready starts with-, don't prepend another--, keep it as a top-level bullet instead of indenting withPlain text summaries (without
-prefix) continue to work as before.