Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Misformatted changelog on "Update Changelog" PR #907

Open
pedro-psb opened this issue Aug 13, 2024 · 3 comments
Open

Misformatted changelog on "Update Changelog" PR #907

pedro-psb opened this issue Aug 13, 2024 · 3 comments
Labels
bug

Comments

@pedro-psb
Copy link
Member

A recent "Update Changelog" PR on pulpcore added a malformed title which broke the changelog ToC page.
See here: pulp/pulpcore@8afdd1a#r145350978

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

Screenshot

image
@pedro-psb pedro-psb added the bug label Aug 13, 2024
pedro-psb added a commit to pedro-psb/pulpcore that referenced this issue Aug 14, 2024
@pedro-psb
Fix misformatted changelog
4332596 
It's not yet clear why it was misformatted, but while we figure it out
it's better to patch those.

Being tracked on pulp/plugin_template#907

[noissue]
@pedro-psb pedro-psb mentioned this issue Aug 14, 2024
Merged
pedro-psb added a commit to pedro-psb/pulpcore that referenced this issue Aug 14, 2024
@pedro-psb
Fix misformatted changelog title
d00833e 
It's not yet clear why it was misformatted, but while we figure it out it's better to patch those.

Being tracked on pulp/plugin_template#907

[noissue]
@pedro-psb pedro-psb mentioned this issue Aug 14, 2024
Merged
@pedro-psb
Copy link
Member Author

AFAIK this appeared originally on 3.57 branch release (pulp/pulpcore@a5c9aec), 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.

dkliban pushed a commit to pulp/pulpcore that referenced this issue Aug 14, 2024
@pedro-psb @dkliban
Fix misformatted changelog title
631caa0 
It's not yet clear why it was misformatted, but while we figure it out it's better to patch those.

Being tracked on pulp/plugin_template#907

[noissue]
dkliban pushed a commit to pulp/pulpcore that referenced this issue Aug 14, 2024
@pedro-psb @dkliban
Fix misformatted changelog
3f1887d 
It's not yet clear why it was misformatted, but while we figure it out
it's better to patch those.

Being tracked on pulp/plugin_template#907

[noissue]
@mdellweg
Copy link
Member

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

pedro-psb added a commit to pedro-psb/pulpcore that referenced this issue Oct 9, 2024
@pedro-psb
Fix misformated changelog titles
978261e 
The root cause is yet unknonw. Fixing while we don't find it.
Being tracked on: pulp/plugin_template#907
@pedro-psb pedro-psb mentioned this issue Oct 9, 2024
Merged
mdellweg pushed a commit to pulp/pulpcore that referenced this issue Oct 10, 2024
@pedro-psb @mdellweg
Fix misformated changelog titles
7eff3fc 
The root cause is yet unknonw. Fixing while we don't find it.
Being tracked on: pulp/plugin_template#907
@pedro-psb
Copy link
Member Author

@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.

pulp/pulp_ansible#2012 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pedro-psb @mdellweg