JoshuaKGoldberg / create-typescript-app

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. πŸ’
MIT License
1.17k stars 74 forks source link

πŸ› Bug: Changelogs have out-of-order headings #915

Open JoshuaKGoldberg opened 1 year ago

JoshuaKGoldberg commented 1 year ago

Bug Report Checklist

Expected

Generated CHANGELOG.md files should follow https://www.w3.org/WAI/tutorials/page-structure/headings/:

Skipping heading ranks can be confusing and should be avoided where possible: Make sure that a <h2> is not followed directly by an <h4>, for example. It is ok to skip ranks when closing subsections, for instance, a <h2> beginning a new section, can follow an <h4> as it closes the previous section.

There should only be one h1 (# ...), at the start of the page

Actual

Generated changelog headings go out of order and have multiple h1s.

Example: https://github.com/KATT/tupleson/blob/55157ef4d6e14ceb6ddf1c0f8ef20a2c51cd6c7b/CHANGELOG.md

Additional Info

I'd previously fixed this in https://github.com/JoshuaKGoldberg/create-typescript-app/issues/107 -> https://github.com/JoshuaKGoldberg/create-typescript-app/pull/109. But changelog generation has since moved to release-it.

Mentioned by @KATT too - thanks!

KATT commented 1 year ago

I have to do a pnpm fix after each PR πŸ™ƒ

(btw, it'd be nice to have an action that auto-fixes and does a commit on lint/prettier issues)