Skip to content

Squash merge messages contain information about all commits by default. #35247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
+55 −21
Draft

Squash merge messages contain information about all commits by default. #35247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
eaf1795
squash merge message
hiifong Aug 11, 2025
3df6e93
fix bug
hiifong Aug 11, 2025
1e67f18
fix bug
hiifong Aug 11, 2025
5039cc9
Update
hiifong Aug 11, 2025
11c3f7f
Update
hiifong Aug 11, 2025
485a27c
Update
hiifong Aug 11, 2025
2a24001
Update
hiifong Aug 11, 2025
5807ae0
Update
hiifong Aug 11, 2025
c318cd0
fix lint
hiifong Aug 11, 2025
0f1aed2
Merge branch 'main' into squash-merge-msg
hiifong Aug 15, 2025
71480fc
Update
hiifong Aug 15, 2025
9ce1cae
Merge branch 'main' into squash-merge-msg
hiifong Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion routers/web/repo/issue_view.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"net/url"
"sort"
"strconv"
"strings"

activities_model "code.gitea.io/gitea/models/activities"
"code.gitea.io/gitea/models/db"
Expand Down Expand Up @@ -933,8 +934,18 @@ func preparePullViewReviewAndMerge(ctx *context.Context, issue *issues_model.Iss
ctx.ServerError("GetDefaultSquashMergeMessage", err)
return
}
_, coAuthors := pull_service.GetSquashMergeCommitMessages(ctx, pull)

defaultSquashMergeBody = fmt.Sprintf("%s%s", defaultSquashMergeBody, coAuthors)

commitsMsg, err := getPullViewSquashMergeCommits(ctx, issue)
if err != nil {
ctx.ServerError("getPullViewSquashMergeCommits", err)
return
}

ctx.Data["DefaultSquashMergeMessage"] = defaultSquashMergeMessage
ctx.Data["DefaultSquashMergeBody"] = defaultSquashMergeBody
ctx.Data["DefaultSquashMergeBody"] = fmt.Sprintf("--------------------\n%s%s", commitsMsg, defaultSquashMergeBody)

pb, err := git_model.GetFirstMatchProtectedBranchRule(ctx, pull.BaseRepoID, pull.BaseBranch)
if err != nil {
Expand Down Expand Up @@ -1006,3 +1017,25 @@ func prepareIssueViewContent(ctx *context.Context, issue *issues_model.Issue) {
return
}
}

func getPullViewSquashMergeCommits(ctx *context.Context, issue *issues_model.Issue) (string, error) {
pull := issue.PullRequest
pull.Issue = issue

baseCommit := GetMergedBaseCommitID(ctx, issue)

compareInfo, err := ctx.Repo.GitRepo.GetCompareInfo(ctx.Repo.Repository.RepoPath(),
baseCommit, pull.GetGitHeadRefName(), false, false)
if err != nil {
return "", err
}

commitsBuilder := strings.Builder{}
for _, c := range compareInfo.Commits {
commitsBuilder.WriteString("* ")
commitsBuilder.WriteString(c.CommitMessage)
Copy link
Contributor

Choose a reason for hiding this comment

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

The same problem:

Image

Copy link
Member Author

Choose a reason for hiding this comment

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

In this case, I would consider it an abuse of commit messages. I believe that squash merge should be an independent feature branch, and I find it hard to believe that every commit message contains so much information. Therefore, I consider this to be an extreme scenario.

Copy link
Member

Choose a reason for hiding this comment

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

I’ve submitted f37de47 to address the issue. This isn’t an uncommon case—many commits include multi-line messages. Do you know how GitHub handles this?

Copy link
Member Author

@hiifong hiifong Aug 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

ref: hiifong/squash-test@beaa913

GitHub's squash merge does not include the PR description, and there seems to be no limit on the length of the commit message.

image

commitsBuilder.WriteRune('\n')
}

return commitsBuilder.String(), nil
}
2 changes: 1 addition & 1 deletion routers/web/repo/pull.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ func prepareViewPullInfo(ctx *context.Context, issue *issues_model.Issue) *git.C
ctx.ServerError("IsUserAllowedToUpdate", err)
return nil
}
ctx.Data["GetCommitMessages"] = pull_service.GetSquashMergeCommitMessages(ctx, pull)
ctx.Data["GetCommitMessages"], _ = pull_service.GetSquashMergeCommitMessages(ctx, pull)
} else {
ctx.Data["GetCommitMessages"] = ""
}
Expand Down
39 changes: 20 additions & 19 deletions services/pull/pull.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,30 +784,30 @@ func CloseRepoBranchesPulls(ctx context.Context, doer *user_model.User, repo *re
var commitMessageTrailersPattern = regexp.MustCompile(`(?:^|\n\n)(?:[\w-]+[ \t]*:[^\n]+\n*(?:[ \t]+[^\n]+\n*)*)+$`)

// GetSquashMergeCommitMessages returns the commit messages between head and merge base (if there is one)
func GetSquashMergeCommitMessages(ctx context.Context, pr *issues_model.PullRequest) string {
func GetSquashMergeCommitMessages(ctx context.Context, pr *issues_model.PullRequest) (string, string) {
if err := pr.LoadIssue(ctx); err != nil {
log.Error("Cannot load issue %d for PR id %d: Error: %v", pr.IssueID, pr.ID, err)
return ""
return "", ""
}

if err := pr.Issue.LoadPoster(ctx); err != nil {
log.Error("Cannot load poster %d for pr id %d, index %d Error: %v", pr.Issue.PosterID, pr.ID, pr.Index, err)
return ""
return "", ""
}

if pr.HeadRepo == nil {
var err error
pr.HeadRepo, err = repo_model.GetRepositoryByID(ctx, pr.HeadRepoID)
if err != nil {
log.Error("GetRepositoryByIdCtx[%d]: %v", pr.HeadRepoID, err)
return ""
return "", ""
}
}

gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, pr.HeadRepo)
if err != nil {
log.Error("Unable to open head repository: Error: %v", err)
return ""
return "", ""
}
defer closer.Close()

Expand All @@ -818,34 +818,35 @@ func GetSquashMergeCommitMessages(ctx context.Context, pr *issues_model.PullRequ
pr.HeadCommitID, err = gitRepo.GetRefCommitID(pr.GetGitHeadRefName())
if err != nil {
log.Error("Unable to get head commit: %s Error: %v", pr.GetGitHeadRefName(), err)
return ""
return "", ""
}
headCommit, err = gitRepo.GetCommit(pr.HeadCommitID)
}
if err != nil {
log.Error("Unable to get head commit: %s Error: %v", pr.HeadBranch, err)
return ""
return "", ""
}

mergeBase, err := gitRepo.GetCommit(pr.MergeBase)
if err != nil {
log.Error("Unable to get merge base commit: %s Error: %v", pr.MergeBase, err)
return ""
return "", ""
}

limit := setting.Repository.PullRequest.DefaultMergeMessageCommitsLimit

commits, err := gitRepo.CommitsBetweenLimit(headCommit, mergeBase, limit, 0)
if err != nil {
log.Error("Unable to get commits between: %s %s Error: %v", pr.HeadBranch, pr.MergeBase, err)
return ""
return "", ""
}

posterSig := pr.Issue.Poster.NewGitSig().String()

uniqueAuthors := make(container.Set[string])
authors := make([]string, 0, len(commits))
stringBuilder := strings.Builder{}
coAuthorStringBuilder := strings.Builder{}

if !setting.Repository.PullRequest.PopulateSquashCommentWithCommitMessages {
message := strings.TrimSpace(pr.Issue.Content)
Expand Down Expand Up @@ -879,12 +880,12 @@ func GetSquashMergeCommitMessages(ctx context.Context, pr *issues_model.PullRequ
}
if _, err := stringBuilder.Write(toWrite); err != nil {
log.Error("Unable to write commit message Error: %v", err)
return ""
return "", ""
}

if _, err := stringBuilder.WriteRune('\n'); err != nil {
log.Error("Unable to write commit message Error: %v", err)
return ""
return "", ""
}
}
}
Expand All @@ -908,7 +909,7 @@ func GetSquashMergeCommitMessages(ctx context.Context, pr *issues_model.PullRequ
commits, err := gitRepo.CommitsBetweenLimit(headCommit, mergeBase, limit, skip)
if err != nil {
log.Error("Unable to get commits between: %s %s Error: %v", pr.HeadBranch, pr.MergeBase, err)
return ""
return "", ""
}
if len(commits) == 0 {
break
Expand All @@ -927,21 +928,21 @@ func GetSquashMergeCommitMessages(ctx context.Context, pr *issues_model.PullRequ
}

for _, author := range authors {
if _, err := stringBuilder.WriteString("Co-authored-by: "); err != nil {
if _, err := coAuthorStringBuilder.WriteString("Co-authored-by: "); err != nil {
log.Error("Unable to write to string builder Error: %v", err)
return ""
return "", ""
}
if _, err := stringBuilder.WriteString(author); err != nil {
if _, err := coAuthorStringBuilder.WriteString(author); err != nil {
log.Error("Unable to write to string builder Error: %v", err)
return ""
return "", ""
}
if _, err := stringBuilder.WriteRune('\n'); err != nil {
if _, err := coAuthorStringBuilder.WriteRune('\n'); err != nil {
log.Error("Unable to write to string builder Error: %v", err)
return ""
return "", ""
}
}

return stringBuilder.String()
return stringBuilder.String(), coAuthorStringBuilder.String()
}

// GetIssuesAllCommitStatus returns a map of issue ID to a list of all statuses for the most recent commit as well as a map of issue ID to only the commit's latest status
Expand Down