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.

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

Towncrier adds double heading #2666

Open
jaraco opened this issue May 6, 2021 · 7 comments
Open

Towncrier adds double heading #2666

jaraco opened this issue May 6, 2021 · 7 comments
Assignees
Labels
bug documentation Needs Implementation Issues that are ready to be implemented. Needs Investigation Issues which are likely in scope but need investigation to figure out the cause task

Comments

@jaraco
Copy link
Member

jaraco commented May 6, 2021

The change that introduced this error was 529419e, which was introduced by running tox -e finalize. It seems towncrier is no longer able to properly finalize the release, so while #2665 addresses the symptom, the root cause, probably introduced in #2654, will still need to be addressed.

Originally posted by @jaraco in #2665 (comment)

@webknjaz, can you triage and propose a solution?

@webknjaz
Copy link
Member

webknjaz commented May 6, 2021

Interesting... @jaraco Can it be that in your pre-cached .tox/finalize/ folder (on your laptop, in the repo checkout) towncrier is v17? It would explain what happened, probably.

@webknjaz
Copy link
Member

webknjaz commented May 6, 2021

But it's still a bit of a mystery to me why the first version doesn't include the underline.

@webknjaz
Copy link
Member

webknjaz commented May 6, 2021

Alright... This is reproducible with the latest towncrier.

Also, I noticed that running towncrier vs towncrier --draft produces different results — the latter returns a proper title while the former writes a broken one into the file.

@webknjaz
Copy link
Member

webknjaz commented May 6, 2021

So apparently this happened in pip almost two weeks ago: pypa/pip#9828 (comment). I'll try to debug this further later.

@webknjaz webknjaz added bug documentation Needs Implementation Issues that are ready to be implemented. Needs Investigation Issues which are likely in scope but need investigation to figure out the cause task labels May 6, 2021
@webknjaz
Copy link
Member

webknjaz commented May 6, 2021

@jaraco feel free to assign the issue to me (I don't have the power to self-assign here)

@webknjaz
Copy link
Member

There is a Towncrier regression that makes normal and draft runs produce different outputs: twisted/towncrier#105. A possible upstream fix is present but looks a bit stale: twisted/towncrier#303.

@vytas7
Copy link

vytas7 commented Oct 16, 2021

I've been struggling with a similar or the same issue: twisted/towncrier#345 (see also: https://github.com/twisted/towncrier/pull/299/files#r619798640).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Needs Implementation Issues that are ready to be implemented. Needs Investigation Issues which are likely in scope but need investigation to figure out the cause task
Projects
None yet
Development

No branches or pull requests

3 participants