dunwright/git-herald
dunwright/git-herald
3
1
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

fix(format): nest multi-line content correctly in blockquotes #82 #83

Merged
imAsparky merged 4 commits from issue-82 into main 2026-04-24 23:24:50 +00:00
Conversation 0 Commits 4 Files changed 8 +192 -33
imAsparky commented 2026-04-24 23:18:31 +00:00
Owner
Copy link

closes #82

closes #82
closes #82
Multi-line dev_notes, doc_notes, and breaking_description previously
escaped the Markdown blockquote on continuation lines because only the
first line carried the `>` prefix. The rendered changelog showed the
first line in a blockquote and subsequent lines as plain paragraph text,
breaking the visual grouping and (depending on renderer) the surrounding
list structure.

Every line of multi-line content is now prefixed with `  > `. The marker
(🔧 / 📝 / ⚠) appears on the first line only, matching the Markdown
convention that a marker introduces the quote rather than heading each
line. Blank lines render as bare `  >`, producing a paragraph break
inside the rendered blockquote per Markdown spec.

Single-line content is byte-identical to the pre-fix output, so existing
changelog entries are unaffected.

[dev-notes]:
"""
ChangelogEntry.format() now delegates to a new static helper
_blockquote(marker, content) for the three multi-line fields. The helper
is private to the class and unused elsewhere.
"""

[doc-notes]:
"""
Multi-line content in [dev-notes] and [doc-notes] commit blocks now
renders correctly in CHANGELOG.md. No action needed — existing entries
are unaffected and new commits with multi-line notes will render as
proper blockquotes.
"""

Closes #82
Refs #80
test(format): Add markdown note format tests #82
All checks were successful
Test Python 3.10 Tests passed on Python 3.10
CI / Test Python 3.10 (pull_request) Successful in 59s
Details
Test Python 3.11 Tests passed on Python 3.11
CI / Test Python 3.11 (pull_request) Successful in 1m6s
Details
Test Python 3.12 Tests passed on Python 3.12
CI / Test Python 3.12 (pull_request) Successful in 57s
Details
Test Python 3.13 Tests passed on Python 3.13
CI / Test Python 3.13 (pull_request) Successful in 57s
Details
Test Python 3.14 Tests passed on Python 3.14
CI / Test Python 3.14 (pull_request) Successful in 57s
Details
CI / Lint and Type Check (pull_request) Successful in 39s
Details
CI / Update Changelog (pull_request) Successful in 10s
Details
6fa851371f
 
closes #82
[skip ci]
imAsparky deleted branch issue-82 2026-04-24 23:24:50 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Compat/Breaking
Breaking change that won't be backward compatible

  
Kind/Bug
Something is not working

  
Kind/Documentation
Documentation changes

  
Kind/Enhancement
Improve existing functionality

  
Kind/Feature
New functionality

  
Kind/Security
This is security issue

  
Kind/Testing
Issue or pull request related to testing

  
Priority
Critical
 The priority is critical

  
Priority
High
 The priority is high

  
Priority
Low
 The priority is low

  
Priority
Medium
 The priority is medium

  
Reviewed
Confirmed
 Issue has been confirmed

  
Reviewed
Duplicate
 This issue or pull request already exists

  
Reviewed
Invalid
 Invalid issue

  
Reviewed
Won't Fix
 This issue won't be fixed

  
Status
Abandoned
 Somebody has started to work on this but abandoned work

  
Status
Blocked
 Something is blocking this issue or pull request

  
Status
Need More Info
 Feedback is required to reproduce issue or to continue work

No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
imAsparky
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
dunwright/git-herald!83
No description provided.