GitHub's squash merge breaks existing git trailer.

[Yaminyam]

Select Topic Area

Question

Body

Yaminyam/backend.ai@859cdf8
GitHub's squash merge retrieves the msg of the existing commit when there is only one commit.
And if a co-author exists, add it as a git trailer.
However, in the process, it seems that the co-author trailer is not integrated with the trailer existing in the existing commit, but is simply concated, including line breaks.
In this case, the existing trailer will not work as a git trailer.

Is there any way to solve this?

[Tgentil]

When you squash merge a pull request in GitHub and include co-authored commits, it's important to ensure that the Co-authored-by: trailers are correctly formatted. If the formatting isn't right, you might face issues with the trailers not functioning as intended. During the squash merge process, manually adjust the commit message to make sure each co-author is on a separate line without extra line breaks. For detailed guidance on creating co-authored commits, check out GitHub's documentation on Creating a commit with multiple authors.

[Yaminyam]

I want to use this to automate.
Of course, a person can correct an incorrect git trailer when they press the squash merge button, but I think incorrect trailer management should be corrected in github itself.

[Tgentil]

Understood, @Yaminyam. Automating the correction of incorrect Git trailers during a squash merge would indeed be a valuable improvement to GitHub's functionality. Currently, manual correction during the squash merge process is the primary method to ensure the trailers are formatted correctly. This limitation highlights an area for potential improvement in GitHub's functionality. Hopefully, we'll see an implementation addressing this in the future.

[Yaminyam]

Oh sorry
The automation I was talking about meant that I was using a squash merge during the automation process, so I couldn't check and fix it manually!