Should word auto Wrapping apply to the trailers lines?

[jamesharris-garmin]

I use a zuul for my CI solution and it depends on the Depends-On: trailer to show links between PRs or gerrit change sets.

the Depends-On: trailer usually takes a url that is way longer than 72 characters. Should we disable auto-wrapping in the attributes paragraph so that it doesn't break trailers?

I'm trying to figure out if this is a but or a feature request. To me this is a bug because it automatically inserts a newline where I don't want one.

[stefanhaller]

You are right that trailer lines shouldn't be wrapped. This came up in #5216, and was fixed in #5230. However, we fixed it only for two frequently used trailers ("Signed-off-by:" and "Co-authored-by:"), not for all in a generic way; see here.

I'm not sure how to best solve this; I'm reluctant to relax the matcher to match by regex (e.g. like this), because this could wrongly match normal text. For example, you could imagine that the last line of a commit message starts with the sentence "However: in this commit blah blah blah", which would wrongly be detected as a trailer.

On the other hand, trying to explicitly hard-code all possible trailers in the code doesn't feel great either; we'll probably miss some.

A third option would be to hard-code as many as we can come up with, and in addition provide a config for users to add more. I'm not really sure it's worth it though.

Any thoughts?

[stefanhaller]

I came up with #5871 to improve this, please test and/or review the approach.

[jamesharris-garmin]

I think we should follow Git's standard for interpreting trailers which is to only consider the final paragraph (as separated by a blank line) for trailers. I'll add comments to your PR for review purposes.

[ShreeChaturvedi]

Upgrade to v0.64.0. #5871 landed there with the generic matcher and the last-paragraph rule you asked for, so Depends-On: with its long URL stays on one line.

If you're stuck on 0.63.x:

git:
  commit:
    autoWrapCommitMessage: false

[jamesharris-garmin]

thanks!