🐛 Bug: Changelogs have out-of-order headings

[JoshuaKGoldberg]

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

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 #107 -> #109. But changelog generation has since moved to release-it.

Mentioned by @KATT too - thanks!

[KATT]

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)

[JoshuaKGoldberg]

Switching from angular to conventionalcommits per semantic-release/changelog#279 (comment) fixes this issue.

Changelog regeneration can be done with:

npx release-it --no-increment --ci --dry-run=false --no-git --no-github --no-npm

(ignore the 0.0.0)

...though that leaves the existing CHANGELOG.md contents in there.

---

So, to regenerate a CHANGELOG.md file:

rm CHANGELOG.md
npx release-it --no-increment --ci --dry-run=false --no-git --no-github --no-npm
pnpx prettier CHANGELOG.md --write
awk '/^## /{count++} count != 1' CHANGELOG.md > temp; mv temp CHANGELOG.md

[github-actions]

🎉 This is included in version v2.46.1 🎉

The release is available on:

• GitHub releases
• npm package (@latest dist-tag)

Cheers! 📦🚀