Skip to content

🐛 Bug: Changelogs have out-of-order headings #915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
3 tasks done
JoshuaKGoldberg opened this issue Oct 1, 2023 · 1 comment
Open
3 tasks done

🐛 Bug: Changelogs have out-of-order headings #915

JoshuaKGoldberg opened this issue Oct 1, 2023 · 1 comment
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Oct 1, 2023

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!

@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( status: accepting prs Please, send a pull request to resolve this! labels Oct 1, 2023
@KATT
Copy link

KATT commented Oct 2, 2023

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Development

No branches or pull requests

2 participants