Skip to content

disable towncrier wrapping - #10538

Merged
wgreenberg merged 1 commit into
mainfrom
no-towncrier-wrap
Jan 16, 2026
Merged

wgreenberg merged 1 commit into
mainfrom
no-towncrier-wrap

Conversation

@bmw

@bmw bmw commented Jan 16, 2026 •

Copy link
Copy Markdown
Member

this PR is a follow up to my comment at #10495 (comment)

i dislike that jsha chose a slightly different column limit than towncrier which caused it to generate awkwardly short lines in our changelog. i also dislike contributors having to remember/know about towncrier's wrapping behavior when writing changelog entries. i'd like us to find a way to not have to worry about this

i initially looked into trying to set towncrier's line length limit to a much higher value, but after searching around https://towncrier.readthedocs.io/en/stable/configuration.html, i don't think it's configurable

instead, i'm proposing here that we remove the wrapping entirely. wrapping was added in response to the discussion at #10379 (comment). every markdown viewer i'm aware of automatically nicely handles wrapping of long lines in markdown. most also automatically merge manually wrapped lines to wrap based on the user's display/settings. finally, since the changelog is automatically edited, i think it'll be rare for certbot devs to have to manually edit the file

because of all this, i think whether the newsfragment was manually wrapped or not is largely irrelevant, we shouldn't worry about it, and we should let people wrap or their newsfragments or not as they see fit

i suppose alternatively we could just let towncrier double/awkwardly wrap entries since i'm making the case that the wrapping doesn't matter, but i personally have a slight preference for this approach. let me know what y'all think

@bmw
bmw requested a review from a team as a code owner January 16, 2026 18:46
@bmw
bmw requested review from ohemorange and removed request for a team January 16, 2026 18:46

@ohemorange ohemorange left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it matters either way, so down to go with either.

@ohemorange
ohemorange requested a review from wgreenberg January 16, 2026 20:42
@wgreenberg

Copy link
Copy Markdown
Collaborator

sgtm

@wgreenberg
wgreenberg merged commit 1ea3519 into main Jan 16, 2026
19 checks passed
@wgreenberg
wgreenberg deleted the no-towncrier-wrap branch January 16, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants