Misformatted changelog on "Update Changelog" PR

pulp / plugin_template

GNU General Public License v2.0

8 stars 35 forks source link

Misformatted changelog on "Update Changelog" PR #907

Open pedro-psb opened 2 months ago

pedro-psb commented 2 months ago

A recent "Update Changelog" PR on pulpcore added a malformed title which broke the changelog ToC page. See here: https://github.com/pulp/pulpcore/commit/8afdd1a531e9cbf7f70beba8c734876b5b2df58f#r145350978

I didn't look into it yet, but maybe it's something that needs adjusting in the collect_changes script.

Screenshot

pedro-psb commented 2 months ago

AFAIK this appeared originally on 3.57 branch release (https://github.com/pulp/pulpcore/commit/a5c9aec474864e36ec5d6ba7082c8a91b97508ab), which is generated by https://github.com/pulp/pulpcore/blob/main/.github/workflows/scripts/release.sh.

By going back to the 3.57.0 release parent commit and running the release.sh commands (basically towncrier) I wasnt able to reproduce it.

mdellweg commented 2 months ago

Sounds like we should just observe if this ever happens again...

pedro-psb commented 1 day ago

@mdellweg had this idea we can investigate:

The use of ## (h2) and #### (h4) without ### (h3) is because we use that level for the plugin api heading, right? Do you think that may be related to what we see here? We probably don't strictly have the same format on all old branches and somwhere a regex for "## " matches part of "### " and boom there we are.

https://github.com/pulp/pulp_ansible/pull/2012#discussion_r1824211466