Let PR titles spread accross multiple lines in the release notes #5521
Conversation
chevdor
added
A0-please_review
|
I also came across GHA such as this one that may help enforcing the format. I also made a test and there is not much preventing a user to make a crazy title. @dvdplm I think 120 is very close to your 1024 example in the sense that we wil likely never hit it. It is something we can monitor though and we can revisit the topic if we hit a title longer than 120 and agree that it makes sense to have it so long. |
| @@ -38,5 +38,5 @@ | |||
| {%- else -%} | |||
| {%- set xcm = "" -%} | |||
| {%- endif -%} | |||
| {{- repo }} {{ audit }}[`#{{c.number}}`]({{c.html_url}}) {{- prio }} - {{ c.title | capitalize | truncate(length=60, end="…") }}{{xcm }} | |||
| {{- repo }} {{ audit }}[`#{{c.number}}`]({{c.html_url}}) {{- prio }} - {{ c.title | capitalize | truncate(length=120, end="…") }}{{xcm }} | |||
There was a problem hiding this comment.
I'd have gone for wider still, 1024. :)
There was a problem hiding this comment.
Seeing some of the releases notes and considering the GH width limit, the limits for a line seems to be around 88 chars left for the PR description. I would even set it to down to 80 to prevent the following:
(This is an extract of the draft for v0.9.26-rc2)
NOTE: No matter how big/wide is your screen, the width is set by the GH UI.
So I would go back lower :)
Truncate at 120 chars vs the previous 60.
60 was barely triggering in the past so 120 favors completeness of the information vs having 100% everything fit on a single line.