Skip to content

🐛 fix(ci): strip ordering markers from changelog section headers#427

Open
sodre wants to merge 1 commit into
mainfrom
fix/changelog-group-header
Open

🐛 fix(ci): strip ordering markers from changelog section headers#427
sodre wants to merge 1 commit into
mainfrom
fix/changelog-group-header

Conversation

@sodre

@sodre sodre commented Jun 23, 2026

Copy link
Copy Markdown
Member

Summary

  • git-cliff section group names in cliff.toml embed <!-- N --> ordering markers (e.g. <!-- 4 -->Refactoring) to control section order. The changelog body template rendered the raw group name, leaking the marker into rendered headers — visible as ### <!-- 4 -->Refactoring in the v0.10.2 changelog and GitHub Release notes.
  • Fix: add the canonical striptags | trim filters to the group header in the body template (### {{ group | striptags | trim | upper_first }}). This is display-only; section ordering is unchanged.

Test plan

  • Rendered the full changelog locally with uvx git-cliff --config cliff.toml — all 12 section headers (Features, Bug Fixes, Refactoring, etc.) render cleanly with zero ### <!-- leaks
  • Confirmed the v0.10.2 section renders as ### Refactoring

🤖 Generated with Claude Code

git-cliff group names embed `<!-- N -->` prefixes to control section
sort order, but the body template rendered the raw group name, leaking
e.g. `### <!-- 4 -->Refactoring` into the changelog and GitHub Release
notes (seen in v0.10.2). Add the canonical `striptags | trim` filters to
the group header so only the label renders. Display-only — section
ordering is unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 29.14%. Comparing base (4f7cd02) to head (b3800e4).
⚠️ Report is 3 commits behind head on main.
✅ All tests successful. No failed tests found.

❗ There is a different number of reports uploaded between BASE (4f7cd02) and HEAD (b3800e4). Click for more details.

HEAD has 3 uploads less than BASE
Flag BASE (4f7cd02) HEAD (b3800e4)
unit 1 0
e2e 1 0
integration 1 0
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #427       +/-   ##
===========================================
- Coverage   92.39%   29.14%   -63.26%     
===========================================
  Files          37       37               
  Lines        7854     7854               
===========================================
- Hits         7257     2289     -4968     
- Misses        597     5565     +4968     
Flag Coverage Δ
doctest 29.14% <ø> (ø)
e2e ?
integration ?
unit ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@sodre sodre marked this pull request as ready for review June 26, 2026 03:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant