Always use an empty line to separate the commit message and trailer #34512

tclin914 · 2025-05-21T01:49:22Z

If the message from form.MergeMessageField is empty, we will miss a "\n" between the title and the "Co-authored-by:" line. The title and message should have a blank line between of them.

wxiaoguang · 2025-05-24T12:20:27Z

routers/web/repo/pull.go

@@ -1109,8 +1109,9 @@ func MergePullRequest(ctx *context.Context) {
 	}

 	form.MergeMessageField = strings.TrimSpace(form.MergeMessageField)
+	message += "\n"


But if form.MergeMessageField was empty, then there will be a unnecessary \n used for the empty message?

We encountered a case where the commit message is empty, and the code at this line appends "\nCo-authored-by: " + sig.String(), using only one \n instead of two. As a result, there is no extra blank line between the commit title and the message body.

Would it be acceptable to always add a \n after the commit title, even if the message body is completely empty (i.e., not even the auto-appended Co-authored-by: ... line)?

Would it be acceptable to always add a \n after the commit title, even if the message body is completely empty (i.e., not even the auto-appended Co-authored-by: ... line)?

Could you design some test cases to show the expected output for each case?

Here is the case we encountered. The commit title and Co-authored-by: line don't have an extra blank line between of them if the commit message is empty. Then it looks like from git log command

and what we see from tig

I'm not familiar with gitea project. Can you guide me how can I add the testcase for my change? Thanks.

I think we can do this: 669cccd

Then the \n can be handled correctly for all cases.

Maybe it's better to have a function like addCommitMessageTailer("Co-authored-by", "..."), and let it handle all cases.

Maybe it's better to have a function like addCommitMessageTailer("Co-authored-by", "..."), and let it handle all cases.

Try this one: 26e1f78

Does the new change work?

@tclin914 ping ~~

It looks good to me. Thanks.

…o-gitea#34512) If the message from form.MergeMessageField is empty, we will miss a "\n" between the title and the "Co-authored-by:" line. The title and message should have a blank line between of them. --------- Co-authored-by: wxiaoguang <[email protected]>

…34512) (#34578) Backport #34512 by tclin914 If the message from form.MergeMessageField is empty, we will miss a "\n" between the title and the "Co-authored-by:" line. The title and message should have a blank line between of them. Co-authored-by: Jim Lin <[email protected]> Co-authored-by: wxiaoguang <[email protected]>

…railer (#8041) This is a port of a gitea PR: go-gitea/gitea#34512. I have added some copy-editing commits on top for cleanliness. I haven't tested the changes manually and only relied on the existing automated test. ## Checklist ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. Co-authored-by: Jim Lin <[email protected]> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8041 Reviewed-by: Earl Warren <[email protected]> Co-authored-by: Antonin Delpeuch <[email protected]> Co-committed-by: Antonin Delpeuch <[email protected]>

* giteaofficial/main: Refactor some tests (go-gitea#34580) Do not mutate incoming options to SearchRepositoryByName (go-gitea#34553) Fix/improve avatar sync from LDAP (go-gitea#34573) Fix some trivial problems (go-gitea#34579) Retain issue sort type when a keyword search is introduced (go-gitea#34559) Always use an empty line to separate the commit message and trailer (go-gitea#34512) Fix line-button issue after file selection in file tree (go-gitea#34574) [skip ci] Updated translations via Crowdin Fix doctor deleting orphaned issues attachments (go-gitea#34142) [skip ci] Updated translations via Crowdin Fix actions skipped commit status indicator (go-gitea#34507) Clean up "file-view" related styles (go-gitea#34558) Add "View workflow file" to Actions list page (go-gitea#34538) Do not mutate incoming options to RenderUserSearch and SearchUsers (go-gitea#34544) Add webhook assigning test and fix possible bug (go-gitea#34420) Fix possible nil description of pull request when migrating from CodeCommit (go-gitea#34541) Refactor commit reader (go-gitea#34542)

## Checklist - [x] go to the last cherry-pick PR (forgejo/forgejo#7965) to figure out how far it went: [gitea@9d4ebc1f2c](go-gitea/gitea@9d4ebc1) - [x] cherry-pick and open PR (forgejo/forgejo#8040) - [ ] have the PR pass the CI - end-to-end (specially important if there are actions related changes) - [ ] add `run-end-to-end` label - [ ] check the result - [ ] write release notes - [ ] assign reviewers - [ ] 48h later, last call - merge 1 hour after the last call ## Legend - ❓ - No decision about the commit has been made. - 🍒 - The commit has been cherry picked. - ⏩ - The commit has been skipped. - 💡 - The commit has been skipped, but should be ported to Forgejo. - ✍️ - The commit has been skipped, and a port to Forgejo already exists. ## Commits - 🍒 [`gitea`](go-gitea/gitea@50d9565) -> [`forgejo`](https://codeberg.org/forgejo/forgejo/commit/c3e6eab73235ac189ca3a36ce2b8ea8d8ad82c81) Add sort option recentclose for issues and pulls ([gitea#34525](go-gitea/gitea#34525)) ## TODO - 💡 [`gitea`](go-gitea/gitea@d5bbaee) Retain issue sort type when a keyword search is introduced ([gitea#34559](go-gitea/gitea#34559)) UI: Small bat might be nice. Test needed? Do we've frontend tests covering the search? ------ - 💡 [`gitea`](go-gitea/gitea@82ea238) Always use an empty line to separate the commit message and trailer ([gitea#34512](go-gitea/gitea#34512)) Needs merge ------ - 💡 [`gitea`](go-gitea/gitea@74858dc) Fix line-button issue after file selection in file tree ([gitea#34574](go-gitea/gitea#34574)) Frontend: Makes it sense to pick/port ui logic in *.ts files? ------ - 💡 [`gitea`](go-gitea/gitea@7149c9c) Fix doctor deleting orphaned issues attachments ([gitea#34142](go-gitea/gitea#34142)) Doctor: seems useful. ------ - 💡 [`gitea`](go-gitea/gitea@0cec4b8) Fix actions skipped commit status indicator ([gitea#34507](go-gitea/gitea#34507)) Actions: Might benefit from additional tests. ------ - 💡 [`gitea`](go-gitea/gitea@4cb0c64) Add "View workflow file" to Actions list page ([gitea#34538](go-gitea/gitea#34538)) Actions: Needs tests ------ - 💡 [`gitea`](go-gitea/gitea@b0936f4) Do not mutate incoming options to RenderUserSearch and SearchUsers ([gitea#34544](go-gitea/gitea#34544)) Nice refactoring but needs manual merge. ------ - 💡 [`gitea`](go-gitea/gitea@498088c) Add webhook assigning test and fix possible bug ([gitea#34420](go-gitea/gitea#34420)) Integrationtest has conflicts needs merge. ------ - 💡 [`gitea`](go-gitea/gitea@24a5105) Fix possible nil description of pull request when migrating from CodeCommit ([gitea#34541](go-gitea/gitea#34541)) Is this relevant to forgejo? Did not find the place to apply this small change. ------ - 💡 [`gitea`](go-gitea/gitea@688da55) Split GetLatestCommitStatus as two functions ([gitea#34535](go-gitea/gitea#34535)) Merge required. ------ - 💡 [`gitea`](go-gitea/gitea@ab96912) Don't display error log when .git-blame-ignore-revs doesn't exist ([gitea#34457](go-gitea/gitea#34457)) Unsure wheter this affects forgejo. Tests missing. ------ - 💡 [`gitea`](go-gitea/gitea@11ee7ff) fix: return 201 Created for CreateVariable API responses ([gitea#34517](go-gitea/gitea#34517)) Actions: This is marked as breaking the api. Pls think about whether this breaking change iss needed & how this impact api-version-increase. The corresponding clinet change can be found here: https://gitea.com/gitea/go-sdk/pulls/713/files ------ - 💡 [`gitea`](go-gitea/gitea@9b295e9) Actions list ([gitea#34530](go-gitea/gitea#34530)) Actions: Regression from go-gitea/gitea#34337 Part of https://codeberg.org/forgejo/forgejo/pulls/7909 ------ ## Skipped - ⏩ [`gitea`](go-gitea/gitea@bb6377d) [skip ci] Updated translations via Crowdin ------ - ⏩ [`gitea`](go-gitea/gitea@07d802a) [skip ci] Updated translations via Crowdin ------ - ⏩ [`gitea`](go-gitea/gitea@c6e2093) Clean up "file-view" related styles ([gitea#34558](go-gitea/gitea#34558)) - gitea ui specific specific ------ - ⏩ [`gitea`](go-gitea/gitea@9f10885) Refactor commit reader ([gitea#34542](go-gitea/gitea#34542)) - gitea refactor specific ------ <details> <summary><h2>Stats</h2></summary> <br> Between [`gitea@9d4ebc1f2c`](go-gitea/gitea@9d4ebc1) and [`gitea@d5bbaee64e`](go-gitea/gitea@d5bbaee), **18** commits have been reviewed. We picked **1**, skipped **4**, and decided to port **13**. </details> Co-authored-by: Markus Amshove <[email protected]> Co-authored-by: Lunny Xiao <[email protected]> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8040 Reviewed-by: Earl Warren <[email protected]> Co-authored-by: Michael Jerger <[email protected]> Co-committed-by: Michael Jerger <[email protected]>

Add "\n" after title unconditionally in case the message is empty

cfd13c1

If the message from form.MergeMessageField is empty, we will miss a "\n" between the title and the "Co-authored-by:" line. The title and message should have a blank line between of them.

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label May 21, 2025

github-actions bot added the modifies/go Pull requests that update Go code label May 21, 2025

wxiaoguang reviewed May 24, 2025

View reviewed changes

wxiaoguang added 4 commits May 26, 2025 18:53

fix

669cccd

fix

26e1f78

improve

6364056

improve

d296520

wxiaoguang approved these changes Jun 2, 2025

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jun 2, 2025

wxiaoguang added this to the 1.25.0 milestone Jun 2, 2025

lunny approved these changes Jun 2, 2025

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jun 2, 2025

wxiaoguang added the backport/v1.24 This PR should be backported to Gitea 1.24 label Jun 2, 2025

Merge branch 'main' into message-blank-line

351dfb4

wxiaoguang enabled auto-merge (squash) June 2, 2025 06:05

wxiaoguang changed the title ~~Add "\n" after title unconditionally in case the message is empty~~ Always use an empty line to separate the commit message and trailer Jun 2, 2025

wxiaoguang merged commit 82ea238 into go-gitea:main Jun 2, 2025
26 checks passed

GiteaBot mentioned this pull request Jun 2, 2025

Always use an empty line to separate the commit message and trailer (#34512) #34578

Merged

GiteaBot added the backport/done All backports for this PR have been created label Jun 2, 2025

tclin914 deleted the message-blank-line branch June 2, 2025 06:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Always use an empty line to separate the commit message and trailer #34512

Always use an empty line to separate the commit message and trailer #34512

Uh oh!

tclin914 commented May 21, 2025

Uh oh!

wxiaoguang May 24, 2025

Uh oh!

tclin914 May 26, 2025

Uh oh!

wxiaoguang May 26, 2025

Uh oh!

tclin914 May 26, 2025

Uh oh!

wxiaoguang May 26, 2025

Uh oh!

wxiaoguang May 27, 2025

Uh oh!

wxiaoguang May 27, 2025

Uh oh!

wxiaoguang May 28, 2025

Uh oh!

wxiaoguang Jun 1, 2025

Uh oh!

tclin914 Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Always use an empty line to separate the commit message and trailer #34512

Always use an empty line to separate the commit message and trailer #34512

Uh oh!

Conversation

tclin914 commented May 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!