Gitea-John71/Gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-08-08 11:17:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

enhance: fall back to DEFAULT_TEMPLATE.md when style-specific template is missing (#38803)

Browse Source 
Closes #38801

Introduce `DEFAULT_TEMPLATE.md` as the default message for all merge
styles.

https://gitea.com/gitea/docs/pulls/491

By the way, fix incorrect os.Expand usage for merge message & repo
template

---------

Co-authored-by: waterWang <waterWang@users.noreply.github.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
This commit is contained in:
water
2026-08-07 22:11:03 +08:00
committed by GitHub
parent a34cc4cac4
commit 2657756cac
9 changed files with 152 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
services/pull/merge.go
+26 -9
View File
@@ -32,6 +32,7 @@ import (
"gitea.dev/modules/references"
repo_module "gitea.dev/modules/repository"
"gitea.dev/modules/setting"
"gitea.dev/modules/templates/vars"
"gitea.dev/modules/timeutil"
"gitea.dev/modules/util"
issue_service "gitea.dev/services/issue"
@@ -66,17 +67,15 @@ func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issue
reviewedBy := pr.GetApprovers(ctx)
if mergeStyle != "" {
templateFilepath := fmt.Sprintf(".gitea/default_merge_message/%s_TEMPLATE.md", strings.ToUpper(string(mergeStyle)))
commit, err := baseGitRepo.GetBranchCommit(ctx, pr.BaseRepo.DefaultBranch)
if err != nil {
return "", "", err
}
templateContent, err := commit.GetFileContent(ctx, baseGitRepo, templateFilepath, setting.Repository.PullRequest.DefaultMergeMessageSize)
templateContent, err := resolveMergeMessageTemplate(ctx, baseGitRepo, commit, mergeStyle)
if err != nil {
if !git.IsErrNotExist(err) {
return "", "", err
}
} else {
return "", "", err
}
if templateContent != "" {
vars := map[string]string{
"BaseRepoOwnerName": pr.BaseRepo.OwnerName,
"BaseRepoName": pr.BaseRepo.Name,
@@ -146,14 +145,32 @@ func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issue
return fmt.Sprintf("Merge pull request '%s' (%s%d) from %s:%s into %s", pr.Issue.Title, issueReference, pr.Issue.Index, pr.HeadRepo.FullName(), pr.HeadBranch, pr.BaseBranch), body, nil
}
func expandDefaultMergeMessage(template string, vars map[string]string) (message, body string) {
// resolveMergeMessageTemplate returns the content of the merge message template for the given
// merge style. It first looks for a style-specific template ({STYLE}_TEMPLATE.md), and falls back
// to the generic DEFAULT_TEMPLATE.md if the style-specific one is not found.
func resolveMergeMessageTemplate(ctx context.Context, baseGitRepo *git.Repository, commit *git.Commit, mergeStyle repo_model.MergeStyle) (string, error) {
templateFilepath := fmt.Sprintf(".gitea/default_merge_message/%s_TEMPLATE.md", strings.ToUpper(string(mergeStyle)))
templateContent, err := commit.GetFileContent(ctx, baseGitRepo, templateFilepath, setting.Repository.PullRequest.DefaultMergeMessageSize)
if err == nil {
return templateContent, nil
}
if !git.IsErrNotExist(err) {
return "", err
}
templateContent, err = commit.GetFileContent(ctx, baseGitRepo, ".gitea/default_merge_message/DEFAULT_TEMPLATE.md", setting.Repository.PullRequest.DefaultMergeMessageSize)
if err == nil || git.IsErrNotExist(err) {
return templateContent, nil
}
return "", err
}
func expandDefaultMergeMessage(template string, varsMap map[string]string) (message, body string) {
message = strings.TrimSpace(template)
if splits := strings.SplitN(message, "\n", 2); len(splits) == 2 {
message = splits[0]
body = strings.TrimSpace(splits[1])
}
mapping := func(s string) string { return vars[s] }
return os.Expand(message, mapping), os.Expand(body, mapping)
return vars.ExpandShellLike(message, varsMap), vars.ExpandShellLike(body, varsMap)
}
// GetDefaultMergeMessage returns default message used when merging pull request
services/pull/merge_test.go
+48
View File
@@ -4,9 +4,13 @@
package pull
import (
"path/filepath"
"testing"
"gitea.dev/modules/git"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func Test_expandDefaultMergeMessage(t *testing.T) {
@@ -90,3 +94,47 @@ func TestAddCommitMessageTailer(t *testing.T) {
assert.Equal(t, "title\n\nTest-tailer: v1\nTest-tailer: v2", AddCommitMessageTailer("title\n\nTest-tailer: v1", "Test-tailer", "v2"))
assert.Equal(t, "title\n\nTest-tailer: v1\nTest-tailer: v2", AddCommitMessageTailer("title\n\nTest-tailer: v1\n", "Test-tailer", "v2"))
}
func TestResolveMergeMessageTemplate(t *testing.T) {
t.Run("NoDefault", func(t *testing.T) {
repo, err := git.ForceFastImportWithInit(t.Context(), filepath.Join(t.TempDir(), "test-repo"), []git.FastImportCommit{
{Ref: "refs/heads/master", Files: []git.FastImportFile{
{Path: ".gitea/default_merge_message/REBASE_TEMPLATE.md", Content: "rebase template"},
}},
})
require.NoError(t, err)
gitRepo, err := git.OpenRepository(t.Context(), repo)
require.NoError(t, err)
defer gitRepo.Close()
commit, err := gitRepo.GetBranchCommit(t.Context(), "master")
require.NoError(t, err)
tmpl, err := resolveMergeMessageTemplate(t.Context(), gitRepo, commit, "merge")
assert.NoError(t, err)
assert.Equal(t, "", tmpl)
tmpl, err = resolveMergeMessageTemplate(t.Context(), gitRepo, commit, "rebase")
assert.NoError(t, err)
assert.Equal(t, "rebase template", tmpl)
})
t.Run("WithDefault", func(t *testing.T) {
repo, err := git.ForceFastImportWithInit(t.Context(), filepath.Join(t.TempDir(), "test-repo"), []git.FastImportCommit{
{Ref: "refs/heads/master", Files: []git.FastImportFile{
{Path: ".gitea/default_merge_message/DEFAULT_TEMPLATE.md", Content: "default template"},
{Path: ".gitea/default_merge_message/REBASE_TEMPLATE.md", Content: "rebase template"},
}},
})
require.NoError(t, err)
gitRepo, err := git.OpenRepository(t.Context(), repo)
require.NoError(t, err)
defer gitRepo.Close()
commit, err := gitRepo.GetBranchCommit(t.Context(), "master")
require.NoError(t, err)
tmpl, err := resolveMergeMessageTemplate(t.Context(), gitRepo, commit, "merge")
assert.NoError(t, err)
assert.Equal(t, "default template", tmpl)
tmpl, err = resolveMergeMessageTemplate(t.Context(), gitRepo, commit, "rebase")
assert.NoError(t, err)
assert.Equal(t, "rebase template", tmpl)
})
}