Skip to content

docs(news): Keep a Changelog sections under gitmoji headings - #1004

Merged
ajslater merged 2 commits into
developfrom
news-gitmoji-sections
Oct 30, 2026
Merged

ajslater merged 2 commits into
developfrom
news-gitmoji-sections

Conversation

@ajslater

Copy link
Copy Markdown
Owner

Summary

  • NEWS.md's roughly 25 section spellings (Fixes, Fix, Fixes:, Dev, Dev Notes, Upgrading, Notice, 🚨 Big Changes 🚨, …) are now standardized on Keep a Changelog 1.1.0 names under gitmoji ### headings.
    • The order is fixed: 💥 Breaking Changes, ✨ Added, ♻️ Changed, 🗑️ Deprecated, 🔥 Removed, 🐛 Fixed, 🔒 Security, 🧑‍💻 Developer.
    • Breaking Changes and Developer are additions to Keep a Changelog. Performance now goes under Changed.
  • Versions whose only content was a yanked or broken note now carry it in the title, for example ## v1.6.18 - Yanked, broken reader. Version headings keep the ## vX.Y.Z[ - Title] form that bin/release_info.py parses.
  • cfg/eslint.config.base.js gets the devenv change ajslater/devenv news-heading-siblings: markdown/no-duplicate-headings uses checkSiblingsOnly: true. A section heading may repeat under each version but still may not repeat within one.
  • The v2.4.1 golden release body in tests/test_release_info.py now expects the new format. GitHub Releases already published keep their old bodies.

The item text was compared before and after conversion and matches, apart from the moved status notes, the Special Thanks line folded into Fixed, and two dropped sub-group colons.

Test plan

  • make lint, make fix (no changes), make ty
  • make test: 1753 Python passed, 1070 frontend passed
  • Negative check: two ### ✨ Added in one version are flagged by markdown/no-duplicate-headings
  • mkdocs build --strict passes. The NEWS page renders the emoji headings, and the sidebar still lists versions only.
  • bin/release_info.py release notes checked for v2.5.8 and v2.0.0

🤖 Generated with Claude Code

Every version's legacy `- Features` style list labels become
`### ✨ Added` style headings in a fixed order: Breaking Changes, Added,
Changed, Deprecated, Removed, Fixed, Security, Developer. About 25 legacy
spellings fold into those; status-only versions (yanked, broken) move
their note into the version title.

cfg/eslint.config.base.js takes devenv's checkSiblingsOnly change so a
section heading may repeat under each version but not within one. The
v2.4.1 golden release body follows the new format; GitHub Releases
already published keep their old bodies.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ajslater
ajslater merged commit 647c14c into develop Oct 30, 2026
9 checks passed
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