Release notes includes changes from too many versions for react-hot-loader

[edmorley]

What Renovate type are you using?
Renovate GitHub App

Describe the bug
The Renovate PR "Release Notes" section for mozilla/treeherder/pull/4767 includes more versions than is updated by the PR.

Specifically: The PR updates react-hot-loader from 4.7.2 to 4.8.0, however the release notes section also includes changes for 4.7.1 and 4.7.2. (CC @sarah-clements)

Did you see anything helpful in debug logs?
N/A

To Reproduce
Steps to reproduce the behavior:

1. Look at release notes section on Update dependency react-hot-loader to v4.8.0 mozilla/treeherder#4767

Expected behavior
That "release notes" only include the changes for 4.8.0, since it's the only new version since the existing version.

Many thanks :-)

[rarkins]

I noticed this the other day. It's breaking our changelog parser because they are using h1 headings for minor releases and h2 for patches:

I was thinking to ask them if they'd consider not doing that, as I haven't seen it done before and it makes parsing the changelog pretty close to impossible unless I hardcode a rule in just for their repo.

Have you seen anything like it before and do you think it's "fair" to suggest to them to normalize their headings like other repos?

[rarkins]

By the way it's kind of a fluke that the changelog you see is so close to what you need. In Renovate's eyes, the changelogs for all patch releases are missing so it's just showing you the 4.8.0 changelog, which happens to have embedded all 4.7.x patches too

[edmorley]

Thank you for your reply :-)
Ah yes makes sense given the difference in heading types. I haven't seen that style anywhere else from what I can remember.

[theKashey]

Probably you shall look at https://github.com/conventional-changelog/releaser-tools - RHL uses it for changelogs.

[rarkins]

@hutson can we get your opinion/expertise here? I’m surprised to see this varying header length as something deliberate rather than accidental.

[rarkins]

Actually I’m a little lost. That tool appears to generate GitHub releases and not Changelog.md

[theKashey]

Ok, so then it's about https://github.com/conventional-changelog/standard-version
Sorry, RHL's pipeline was made not by me, and I am not using the same configuration elsewhere.

[rarkins]

Thanks. So it appears it’s definitely not unintended (the conventional changelog repo itself uses h1 for Major and minor and h2 for patch) so we need a way to detect and support it.

[rarkins]

I know this issue is older, but let's track this feature in #5181 instead