Skip to content

Commit 4a685f8

Browse files
apricotelafriks
apricote
authored and
lafriks
committed
Add rebase with merge commit merge style (#3844) (#4052)
Signed-off-by: Julian Tölle <julian.toelle97@gmail.com>
1 parent 58bdff5 commit 4a685f8

File tree

14 files changed

+162
-5
lines changed

14 files changed

+162
-5
lines changed

‎integrations/pull_merge_test.go

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,19 @@ func TestPullRebase(t *testing.T) {
7777
testPullMerge(t, session, elem[1], elem[2], elem[4], models.MergeStyleRebase)
7878
}
7979

80+
func TestPullRebaseMerge(t *testing.T) {
81+
prepareTestEnv(t)
82+
session := loginUser(t, "user1")
83+
testRepoFork(t, session, "user2", "repo1", "user1", "repo1")
84+
testEditFile(t, session, "user1", "repo1", "master", "README.md", "Hello, World (Edited)\n")
85+
86+
resp := testPullCreate(t, session, "user1", "repo1", "master", "This is a pull title")
87+
88+
elem := strings.Split(test.RedirectURL(resp), "/")
89+
assert.EqualValues(t, "pulls", elem[3])
90+
testPullMerge(t, session, elem[1], elem[2], elem[4], models.MergeStyleRebaseMerge)
91+
}
92+
8093
func TestPullSquash(t *testing.T) {
8194
prepareTestEnv(t)
8295
session := loginUser(t, "user1")

‎models/fixtures/repo_unit.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
id: 5
3131
repo_id: 1
3232
type: 3
33-
config: "{\"IgnoreWhitespaceConflicts\":false,\"AllowMerge\":true,\"AllowRebase\":true,\"AllowSquash\":true}"
33+
config: "{\"IgnoreWhitespaceConflicts\":false,\"AllowMerge\":true,\"AllowRebase\":true,\"AllowRebaseMerge\":true,\"AllowSquash\":true}"
3434
created_unix: 946684810
3535

3636
-
@@ -51,7 +51,7 @@
5151
id: 8
5252
repo_id: 3
5353
type: 3
54-
config: "{\"IgnoreWhitespaceConflicts\":true,\"AllowMerge\":true,\"AllowRebase\":false,\"AllowSquash\":false}"
54+
config: "{\"IgnoreWhitespaceConflicts\":true,\"AllowMerge\":true,\"AllowRebase\":false,\"AllowRebaseMerge\":true,\"AllowSquash\":false}"
5555
created_unix: 946684810
5656

5757
-

‎models/migrations/migrations.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,8 @@ var migrations = []Migration{
204204
NewMigration("add approval whitelists to protected branches", addApprovalWhitelistsToProtectedBranches),
205205
// v75 -> v76
206206
NewMigration("clear nonused data which not deleted when user was deleted", clearNonusedData),
207+
// v76 -> v77
208+
NewMigration("add pull request rebase with merge commit", addPullRequestRebaseWithMerge),
207209
}
208210

209211
// Migrate database to current version

‎models/migrations/v76.go

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Copyright 2018 The Gitea Authors. All rights reserved.
2+
// Use of this source code is governed by a MIT-style
3+
// license that can be found in the LICENSE file.
4+
5+
package migrations
6+
7+
import (
8+
"fmt"
9+
10+
"code.gitea.io/gitea/modules/util"
11+
12+
"github.com/go-xorm/xorm"
13+
)
14+
15+
func addPullRequestRebaseWithMerge(x *xorm.Engine) error {
16+
// RepoUnit describes all units of a repository
17+
type RepoUnit struct {
18+
ID int64
19+
RepoID int64 `xorm:"INDEX(s)"`
20+
Type int `xorm:"INDEX(s)"`
21+
Config map[string]interface{} `xorm:"JSON"`
22+
CreatedUnix util.TimeStamp `xorm:"INDEX CREATED"`
23+
}
24+
25+
sess := x.NewSession()
26+
defer sess.Close()
27+
if err := sess.Begin(); err != nil {
28+
return err
29+
}
30+
31+
//Updating existing issue units
32+
units := make([]*RepoUnit, 0, 100)
33+
if err := sess.Where("`type` = ?", V16UnitTypePRs).Find(&units); err != nil {
34+
return fmt.Errorf("Query repo units: %v", err)
35+
}
36+
for _, unit := range units {
37+
if unit.Config == nil {
38+
unit.Config = make(map[string]interface{})
39+
}
40+
// Allow the new merge style if all other merge styles are allowed
41+
allowMergeRebase := true
42+
43+
if allowMerge, ok := unit.Config["AllowMerge"]; ok {
44+
allowMergeRebase = allowMergeRebase && allowMerge.(bool)
45+
}
46+
47+
if allowRebase, ok := unit.Config["AllowRebase"]; ok {
48+
allowMergeRebase = allowMergeRebase && allowRebase.(bool)
49+
}
50+
51+
if allowSquash, ok := unit.Config["AllowSquash"]; ok {
52+
allowMergeRebase = allowMergeRebase && allowSquash.(bool)
53+
}
54+
55+
if _, ok := unit.Config["AllowRebaseMerge"]; !ok {
56+
unit.Config["AllowRebaseMerge"] = allowMergeRebase
57+
}
58+
if _, err := sess.ID(unit.ID).Cols("config").Update(unit); err != nil {
59+
return err
60+
}
61+
}
62+
return sess.Commit()
63+
}

‎models/pull.go

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,8 @@ const (
297297
MergeStyleMerge MergeStyle = "merge"
298298
// MergeStyleRebase rebase before merging
299299
MergeStyleRebase MergeStyle = "rebase"
300+
// MergeStyleRebaseMerge rebase before merging with merge commit (--no-ff)
301+
MergeStyleRebaseMerge MergeStyle = "rebase-merge"
300302
// MergeStyleSquash squash commits into single commit before merging
301303
MergeStyleSquash MergeStyle = "squash"
302304
)
@@ -434,6 +436,41 @@ func (pr *PullRequest) Merge(doer *User, baseGitRepo *git.Repository, mergeStyle
434436
"git", "merge", "--ff-only", "-q", "head_repo_"+pr.HeadBranch); err != nil {
435437
return fmt.Errorf("git merge --ff-only [%s -> %s]: %s", headRepoPath, tmpBasePath, stderr)
436438
}
439+
case MergeStyleRebaseMerge:
440+
// Checkout head branch
441+
if _, stderr, err = process.GetManager().ExecDir(-1, tmpBasePath,
442+
fmt.Sprintf("PullRequest.Merge (git checkout): %s", tmpBasePath),
443+
"git", "checkout", "-b", "head_repo_"+pr.HeadBranch, "head_repo/"+pr.HeadBranch); err != nil {
444+
return fmt.Errorf("git checkout: %s", stderr)
445+
}
446+
// Rebase before merging
447+
if _, stderr, err = process.GetManager().ExecDir(-1, tmpBasePath,
448+
fmt.Sprintf("PullRequest.Merge (git rebase): %s", tmpBasePath),
449+
"git", "rebase", "-q", pr.BaseBranch); err != nil {
450+
return fmt.Errorf("git rebase [%s -> %s]: %s", headRepoPath, tmpBasePath, stderr)
451+
}
452+
// Checkout base branch again
453+
if _, stderr, err = process.GetManager().ExecDir(-1, tmpBasePath,
454+
fmt.Sprintf("PullRequest.Merge (git checkout): %s", tmpBasePath),
455+
"git", "checkout", pr.BaseBranch); err != nil {
456+
return fmt.Errorf("git checkout: %s", stderr)
457+
}
458+
// Prepare merge with commit
459+
if _, stderr, err = process.GetManager().ExecDir(-1, tmpBasePath,
460+
fmt.Sprintf("PullRequest.Merge (git merge): %s", tmpBasePath),
461+
"git", "merge", "--no-ff", "--no-commit", "-q", "head_repo_"+pr.HeadBranch); err != nil {
462+
return fmt.Errorf("git merge --no-ff [%s -> %s]: %s", headRepoPath, tmpBasePath, stderr)
463+
}
464+
465+
// Set custom message and author and create merge commit
466+
sig := doer.NewGitSig()
467+
if _, stderr, err = process.GetManager().ExecDir(-1, tmpBasePath,
468+
fmt.Sprintf("PullRequest.Merge (git commit): %s", tmpBasePath),
469+
"git", "commit", fmt.Sprintf("--author='%s <%s>'", sig.Name, sig.Email),
470+
"-m", message); err != nil {
471+
return fmt.Errorf("git commit [%s]: %v - %s", tmpBasePath, err, stderr)
472+
}
473+
437474
case MergeStyleSquash:
438475
// Merge with squash
439476
if _, stderr, err = process.GetManager().ExecDir(-1, tmpBasePath,

‎models/repo.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1298,7 +1298,7 @@ func createRepository(e *xorm.Session, doer, u *User, repo *Repository) (err err
12981298
units = append(units, RepoUnit{
12991299
RepoID: repo.ID,
13001300
Type: tp,
1301-
Config: &PullRequestsConfig{AllowMerge: true, AllowRebase: true, AllowSquash: true},
1301+
Config: &PullRequestsConfig{AllowMerge: true, AllowRebase: true, AllowRebaseMerge: true, AllowSquash: true},
13021302
})
13031303
} else {
13041304
units = append(units, RepoUnit{

‎models/repo_unit.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ type PullRequestsConfig struct {
9191
IgnoreWhitespaceConflicts bool
9292
AllowMerge bool
9393
AllowRebase bool
94+
AllowRebaseMerge bool
9495
AllowSquash bool
9596
}
9697

@@ -108,6 +109,7 @@ func (cfg *PullRequestsConfig) ToDB() ([]byte, error) {
108109
func (cfg *PullRequestsConfig) IsMergeStyleAllowed(mergeStyle MergeStyle) bool {
109110
return mergeStyle == MergeStyleMerge && cfg.AllowMerge ||
110111
mergeStyle == MergeStyleRebase && cfg.AllowRebase ||
112+
mergeStyle == MergeStyleRebaseMerge && cfg.AllowRebaseMerge ||
111113
mergeStyle == MergeStyleSquash && cfg.AllowSquash
112114
}
113115

‎modules/auth/repo_form.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ type RepoSettingForm struct {
112112
PullsIgnoreWhitespace bool
113113
PullsAllowMerge bool
114114
PullsAllowRebase bool
115+
PullsAllowRebaseMerge bool
115116
PullsAllowSquash bool
116117
EnableTimetracker bool
117118
AllowOnlyContributorsToTrackTime bool
@@ -363,7 +364,7 @@ func (f *InitializeLabelsForm) Validate(ctx *macaron.Context, errs binding.Error
363364

364365
// MergePullRequestForm form for merging Pull Request
365366
type MergePullRequestForm struct {
366-
Do string `binding:"Required;In(merge,rebase,squash)"`
367+
Do string `binding:"Required;In(merge,rebase,rebase-merge,squash)"`
367368
MergeTitleField string
368369
MergeMessageField string
369370
}

‎options/locale/locale_en-US.ini

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -868,6 +868,7 @@ pulls.no_merge_helper = Enable merge options in the repository settings or merge
868868
pulls.no_merge_wip = This pull request can not be merged because it is marked as being a work in progress.
869869
pulls.merge_pull_request = Merge Pull Request
870870
pulls.rebase_merge_pull_request = Rebase and Merge
871+
pulls.rebase_merge_commit_pull_request = Rebase and Merge (--no-ff)
871872
pulls.squash_merge_pull_request = Squash and Merge
872873
pulls.invalid_merge_option = You cannot use this merge option for this pull request.
873874
pulls.open_unmerged_pull_exists = `You cannot perform a reopen operation because there is a pending pull request (#%d) with identical properties.`
@@ -1013,6 +1014,7 @@ settings.pulls_desc = Enable Repository Pull Requests
10131014
settings.pulls.ignore_whitespace = Ignore Whitespace for Conflicts
10141015
settings.pulls.allow_merge_commits = Enable Commit Merging
10151016
settings.pulls.allow_rebase_merge = Enable Rebasing to Merge Commits
1017+
settings.pulls.allow_rebase_merge_commit = Enable Rebasing with explicit merge commits (--no-ff)
10161018
settings.pulls.allow_squash_commits = Enable Squashing to Merge Commits
10171019
settings.admin_settings = Administrator Settings
10181020
settings.admin_enable_health_check = Enable Repository Health Checks (git fsck)

‎routers/repo/issue.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,8 @@ func ViewIssue(ctx *context.Context) {
843843
ctx.Data["MergeStyle"] = models.MergeStyleMerge
844844
} else if prConfig.AllowRebase {
845845
ctx.Data["MergeStyle"] = models.MergeStyleRebase
846+
} else if prConfig.AllowRebaseMerge {
847+
ctx.Data["MergeStyle"] = models.MergeStyleRebaseMerge
846848
} else if prConfig.AllowSquash {
847849
ctx.Data["MergeStyle"] = models.MergeStyleSquash
848850
} else {

‎routers/repo/pull.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,9 @@ func MergePullRequest(ctx *context.Context, form auth.MergePullRequestForm) {
552552
if models.MergeStyle(form.Do) == models.MergeStyleMerge {
553553
message = pr.GetDefaultMergeMessage()
554554
}
555+
if models.MergeStyle(form.Do) == models.MergeStyleRebaseMerge {
556+
message = pr.GetDefaultMergeMessage()
557+
}
555558
if models.MergeStyle(form.Do) == models.MergeStyleSquash {
556559
message = pr.GetDefaultSquashMessage()
557560
}

‎routers/repo/setting.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ func SettingsPost(ctx *context.Context, form auth.RepoSettingForm) {
227227
IgnoreWhitespaceConflicts: form.PullsIgnoreWhitespace,
228228
AllowMerge: form.PullsAllowMerge,
229229
AllowRebase: form.PullsAllowRebase,
230+
AllowRebaseMerge: form.PullsAllowRebaseMerge,
230231
AllowSquash: form.PullsAllowSquash,
231232
},
232233
})

‎templates/repo/issue/view_content/pull.tmpl

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
</div>
8787
{{if .AllowMerge}}
8888
{{$prUnit := .Repository.MustGetUnit $.UnitTypePullRequests}}
89-
{{if or $prUnit.PullRequestsConfig.AllowMerge $prUnit.PullRequestsConfig.AllowRebase $prUnit.PullRequestsConfig.AllowSquash}}
89+
{{if or $prUnit.PullRequestsConfig.AllowMerge $prUnit.PullRequestsConfig.AllowRebase $prUnit.PullRequestsConfig.AllowRebaseMerge $prUnit.PullRequestsConfig.AllowSquash}}
9090
<div class="ui divider"></div>
9191
{{if $prUnit.PullRequestsConfig.AllowMerge}}
9292
<div class="ui form merge-fields" style="display: none">
@@ -120,6 +120,25 @@
120120
</form>
121121
</div>
122122
{{end}}
123+
{{if $prUnit.PullRequestsConfig.AllowRebaseMerge}}
124+
<div class="ui form rebase-merge-fields" style="display: none">
125+
<form action="{{.Link}}/merge" method="post">
126+
{{.CsrfTokenHtml}}
127+
<div class="field">
128+
<input type="text" name="merge_title_field" value="{{.Issue.PullRequest.GetDefaultMergeMessage}}">
129+
</div>
130+
<div class="field">
131+
<textarea name="merge_message_field" rows="5" placeholder="{{$.i18n.Tr "repo.editor.commit_message_desc"}}"></textarea>
132+
</div>
133+
<button class="ui green button" type="submit" name="do" value="rebase-merge">
134+
{{$.i18n.Tr "repo.pulls.rebase_merge_commit_pull_request"}}
135+
</button>
136+
<button class="ui button merge-cancel">
137+
{{$.i18n.Tr "cancel"}}
138+
</button>
139+
</form>
140+
</div>
141+
{{end}}
123142
{{if $prUnit.PullRequestsConfig.AllowSquash}}
124143
<div class="ui form squash-fields" style="display: none">
125144
<form action="{{.Link}}/merge" method="post">
@@ -149,6 +168,9 @@
149168
{{if eq .MergeStyle "rebase"}}
150169
{{$.i18n.Tr "repo.pulls.rebase_merge_pull_request"}}
151170
{{end}}
171+
{{if eq .MergeStyle "rebase-merge"}}
172+
{{$.i18n.Tr "repo.pulls.rebase_merge_commit_pull_request"}}
173+
{{end}}
152174
{{if eq .MergeStyle "squash"}}
153175
{{$.i18n.Tr "repo.pulls.squash_merge_pull_request"}}
154176
{{end}}
@@ -163,6 +185,9 @@
163185
{{if $prUnit.PullRequestsConfig.AllowRebase}}
164186
<div class="item{{if eq .MergeStyle "rebase"}} active selected{{end}}" data-do="rebase">{{$.i18n.Tr "repo.pulls.rebase_merge_pull_request"}}</div>
165187
{{end}}
188+
{{if $prUnit.PullRequestsConfig.AllowRebaseMerge}}
189+
<div class="item{{if eq .MergeStyle "rebase-merge"}} active selected{{end}}" data-do="rebase-merge">{{$.i18n.Tr "repo.pulls.rebase_merge_commit_pull_request"}}</div>
190+
{{end}}
166191
{{if $prUnit.PullRequestsConfig.AllowSquash}}
167192
<div class="item{{if eq .MergeStyle "squash"}} active selected{{end}}" data-do="squash">{{$.i18n.Tr "repo.pulls.squash_merge_pull_request"}}</div>
168193
{{end}}

‎templates/repo/settings/options.tmpl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,12 @@
227227
<label>{{.i18n.Tr "repo.settings.pulls.allow_rebase_merge"}}</label>
228228
</div>
229229
</div>
230+
<div class="field">
231+
<div class="ui checkbox">
232+
<input name="pulls_allow_rebase_merge" type="checkbox" {{if or (not $pullRequestEnabled) ($prUnit.PullRequestsConfig.AllowRebaseMerge)}}checked{{end}}>
233+
<label>{{.i18n.Tr "repo.settings.pulls.allow_rebase_merge_commit"}}</label>
234+
</div>
235+
</div>
230236
<div class="field">
231237
<div class="ui checkbox">
232238
<input name="pulls_allow_squash" type="checkbox" {{if or (not $pullRequestEnabled) ($prUnit.PullRequestsConfig.AllowSquash)}}checked{{end}}>

0 commit comments

Comments
 (0)