Skip to content

Commit 73b2151

Browse files
chrisncchrisnc
committed
Add a fast-forward-only merge style. (#24906)
1 parent 01acd1e commit 73b2151

File tree

19 files changed

+80
-4
lines changed

19 files changed

+80
-4
lines changed

‎models/repo/git.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ const (
2121
MergeStyleRebaseMerge MergeStyle = "rebase-merge"
2222
// MergeStyleSquash squash commits into single commit before merging
2323
MergeStyleSquash MergeStyle = "squash"
24+
// MergeStyleFastForwardOnly fast-forward merge if possible, otherwise fail
25+
MergeStyleFastForwardOnly MergeStyle = "fast-forward-only"
2426
// MergeStyleManuallyMerged pr has been merged manually, just mark it as merged directly
2527
MergeStyleManuallyMerged MergeStyle = "manually-merged"
2628
// MergeStyleRebaseUpdate not a merge style, used to update pull head by rebase

‎models/repo/repo_unit.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ type PullRequestsConfig struct {
122122
AllowRebase bool
123123
AllowRebaseMerge bool
124124
AllowSquash bool
125+
AllowFastForwardOnly bool
125126
AllowManualMerge bool
126127
AutodetectManualMerge bool
127128
AllowRebaseUpdate bool
@@ -148,6 +149,7 @@ func (cfg *PullRequestsConfig) IsMergeStyleAllowed(mergeStyle MergeStyle) bool {
148149
mergeStyle == MergeStyleRebase && cfg.AllowRebase ||
149150
mergeStyle == MergeStyleRebaseMerge && cfg.AllowRebaseMerge ||
150151
mergeStyle == MergeStyleSquash && cfg.AllowSquash ||
152+
mergeStyle == MergeStyleFastForwardOnly && cfg.AllowFastForwardOnly ||
151153
mergeStyle == MergeStyleManuallyMerged && cfg.AllowManualMerge
152154
}
153155

‎modules/git/error.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ func (err ErrBranchNotExist) Unwrap() error {
9696
return util.ErrNotExist
9797
}
9898

99-
// ErrPushOutOfDate represents an error if merging fails due to unrelated histories
99+
// ErrPushOutOfDate represents an error if merging fails due to the base branch being updated
100100
type ErrPushOutOfDate struct {
101101
StdOut string
102102
StdErr string

‎modules/repository/create.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,11 @@ func CreateRepositoryByExample(ctx context.Context, doer, u *user_model.User, re
8787
units = append(units, repo_model.RepoUnit{
8888
RepoID: repo.ID,
8989
Type: tp,
90-
Config: &repo_model.PullRequestsConfig{AllowMerge: true, AllowRebase: true, AllowRebaseMerge: true, AllowSquash: true, DefaultMergeStyle: repo_model.MergeStyle(setting.Repository.PullRequest.DefaultMergeStyle), AllowRebaseUpdate: true},
90+
Config: &repo_model.PullRequestsConfig{
91+
AllowMerge: true, AllowRebase: true, AllowRebaseMerge: true, AllowSquash: true, AllowFastForwardOnly: true,
92+
DefaultMergeStyle: repo_model.MergeStyle(setting.Repository.PullRequest.DefaultMergeStyle),
93+
AllowRebaseUpdate: true,
94+
},
9195
})
9296
} else {
9397
units = append(units, repo_model.RepoUnit{

‎modules/structs/repo.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ type Repository struct {
9898
AllowRebase bool `json:"allow_rebase"`
9999
AllowRebaseMerge bool `json:"allow_rebase_explicit"`
100100
AllowSquash bool `json:"allow_squash_merge"`
101+
AllowFastForwardOnly bool `json:"allow_fast_forward_only_merge"`
101102
AllowRebaseUpdate bool `json:"allow_rebase_update"`
102103
DefaultDeleteBranchAfterMerge bool `json:"default_delete_branch_after_merge"`
103104
DefaultMergeStyle string `json:"default_merge_style"`
@@ -195,6 +196,8 @@ type EditRepoOption struct {
195196
AllowRebaseMerge *bool `json:"allow_rebase_explicit,omitempty"`
196197
// either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
197198
AllowSquash *bool `json:"allow_squash_merge,omitempty"`
199+
// either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging.
200+
AllowFastForwardOnly *bool `json:"allow_fast_forward_only_merge,omitempty"`
198201
// either `true` to allow mark pr as merged manually, or `false` to prevent it.
199202
AllowManualMerge *bool `json:"allow_manual_merge,omitempty"`
200203
// either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.

‎options/locale/locale_en-US.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1775,6 +1775,7 @@ pulls.merge_pull_request = Create merge commit
17751775
pulls.rebase_merge_pull_request = Rebase then fast-forward
17761776
pulls.rebase_merge_commit_pull_request = Rebase then create merge commit
17771777
pulls.squash_merge_pull_request = Create squash commit
1778+
pulls.fast_forward_only_merge_pull_request = Fast-forward
17781779
pulls.merge_manually = Manually merged
17791780
pulls.merge_commit_id = The merge commit ID
17801781
pulls.require_signed_wont_sign = The branch requires signed commits but this merge will not be signed

‎routers/api/v1/repo/repo.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -883,6 +883,7 @@ func updateRepoUnits(ctx *context.APIContext, opts api.EditRepoOption) error {
883883
AllowRebase: true,
884884
AllowRebaseMerge: true,
885885
AllowSquash: true,
886+
AllowFastForwardOnly: true,
886887
AllowManualMerge: true,
887888
AutodetectManualMerge: false,
888889
AllowRebaseUpdate: true,
@@ -909,6 +910,9 @@ func updateRepoUnits(ctx *context.APIContext, opts api.EditRepoOption) error {
909910
if opts.AllowSquash != nil {
910911
config.AllowSquash = *opts.AllowSquash
911912
}
913+
if opts.AllowFastForwardOnly != nil {
914+
config.AllowFastForwardOnly = *opts.AllowFastForwardOnly
915+
}
912916
if opts.AllowManualMerge != nil {
913917
config.AllowManualMerge = *opts.AllowManualMerge
914918
}

‎routers/api/v1/repo/repo_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ func TestRepoEdit(t *testing.T) {
3535
allowRebase := false
3636
allowRebaseMerge := false
3737
allowSquashMerge := false
38+
allowFastForwardOnlyMerge := false
3839
archived := true
3940
opts := api.EditRepoOption{
4041
Name: &ctx.Repo.Repository.Name,
@@ -50,6 +51,7 @@ func TestRepoEdit(t *testing.T) {
5051
AllowRebase: &allowRebase,
5152
AllowRebaseMerge: &allowRebaseMerge,
5253
AllowSquash: &allowSquashMerge,
54+
AllowFastForwardOnly: &allowFastForwardOnlyMerge,
5355
Archived: &archived,
5456
}
5557

‎routers/web/repo/issue.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1862,6 +1862,8 @@ func ViewIssue(ctx *context.Context) {
18621862
mergeStyle = repo_model.MergeStyleRebaseMerge
18631863
} else if prConfig.AllowSquash {
18641864
mergeStyle = repo_model.MergeStyleSquash
1865+
} else if prConfig.AllowFastForwardOnly {
1866+
mergeStyle = repo_model.MergeStyleFastForwardOnly
18651867
} else if prConfig.AllowManualMerge {
18661868
mergeStyle = repo_model.MergeStyleManuallyMerged
18671869
}

‎routers/web/repo/setting/setting.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,7 @@ func SettingsPost(ctx *context.Context) {
576576
AllowRebase: form.PullsAllowRebase,
577577
AllowRebaseMerge: form.PullsAllowRebaseMerge,
578578
AllowSquash: form.PullsAllowSquash,
579+
AllowFastForwardOnly: form.PullsAllowFastForwardOnly,
579580
AllowManualMerge: form.PullsAllowManualMerge,
580581
AutodetectManualMerge: form.EnableAutodetectManualMerge,
581582
AllowRebaseUpdate: form.PullsAllowRebaseUpdate,

‎services/convert/repository.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ func innerToRepo(ctx context.Context, repo *repo_model.Repository, permissionInR
9393
allowRebase := false
9494
allowRebaseMerge := false
9595
allowSquash := false
96+
allowFastForwardOnly := false
9697
allowRebaseUpdate := false
9798
defaultDeleteBranchAfterMerge := false
9899
defaultMergeStyle := repo_model.MergeStyleMerge
@@ -105,6 +106,7 @@ func innerToRepo(ctx context.Context, repo *repo_model.Repository, permissionInR
105106
allowRebase = config.AllowRebase
106107
allowRebaseMerge = config.AllowRebaseMerge
107108
allowSquash = config.AllowSquash
109+
allowFastForwardOnly = config.AllowFastForwardOnly
108110
allowRebaseUpdate = config.AllowRebaseUpdate
109111
defaultDeleteBranchAfterMerge = config.DefaultDeleteBranchAfterMerge
110112
defaultMergeStyle = config.GetDefaultMergeStyle()
@@ -219,6 +221,7 @@ func innerToRepo(ctx context.Context, repo *repo_model.Repository, permissionInR
219221
AllowRebase: allowRebase,
220222
AllowRebaseMerge: allowRebaseMerge,
221223
AllowSquash: allowSquash,
224+
AllowFastForwardOnly: allowFastForwardOnly,
222225
AllowRebaseUpdate: allowRebaseUpdate,
223226
DefaultDeleteBranchAfterMerge: defaultDeleteBranchAfterMerge,
224227
DefaultMergeStyle: string(defaultMergeStyle),

‎services/forms/repo_form.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ type RepoSettingForm struct {
151151
PullsAllowRebase bool
152152
PullsAllowRebaseMerge bool
153153
PullsAllowSquash bool
154+
PullsAllowFastForwardOnly bool
154155
PullsAllowManualMerge bool
155156
PullsDefaultMergeStyle string
156157
EnableAutodetectManualMerge bool

‎services/pull/merge.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,10 @@ func doMergeAndPush(ctx context.Context, pr *issues_model.PullRequest, doer *use
267267
if err := doMergeStyleSquash(mergeCtx, message); err != nil {
268268
return "", err
269269
}
270+
case repo_model.MergeStyleFastForwardOnly:
271+
if err := doMergeStyleFastForwardOnly(mergeCtx); err != nil {
272+
return "", err
273+
}
270274
default:
271275
return "", models.ErrInvalidMergeStyle{ID: pr.BaseRepo.ID, Style: mergeStyle}
272276
}

‎services/pull/merge_ff_only.go

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Copyright 2023 The Gitea Authors. All rights reserved.
2+
// SPDX-License-Identifier: MIT
3+
4+
package pull
5+
6+
import (
7+
repo_model "code.gitea.io/gitea/models/repo"
8+
"code.gitea.io/gitea/modules/git"
9+
"code.gitea.io/gitea/modules/log"
10+
)
11+
12+
// doMergeStyleFastForwardOnly merges the tracking into the current HEAD - which is assumed to be staging branch (equal to the pr.BaseBranch)
13+
func doMergeStyleFastForwardOnly(ctx *mergeContext) error {
14+
cmd := git.NewCommand(ctx, "merge", "--ff-only").AddDynamicArguments(trackingBranch)
15+
if err := runMergeCommand(ctx, repo_model.MergeStyleFastForwardOnly, cmd); err != nil {
16+
log.Error("%-v Unable to merge tracking into base: %v", ctx.pr, err)
17+
return err
18+
}
19+
20+
return nil
21+
}

‎services/pull/merge_merge.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"code.gitea.io/gitea/modules/log"
1010
)
1111

12-
// doMergeStyleMerge merges the tracking into the current HEAD - which is assumed to tbe staging branch (equal to the pr.BaseBranch)
12+
// doMergeStyleMerge merges the tracking branch into the current HEAD - which is assumed to be the staging branch (equal to the pr.BaseBranch)
1313
func doMergeStyleMerge(ctx *mergeContext, message string) error {
1414
cmd := git.NewCommand(ctx, "merge", "--no-ff", "--no-commit").AddDynamicArguments(trackingBranch)
1515
if err := runMergeCommand(ctx, repo_model.MergeStyleMerge, cmd); err != nil {

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@
197197
{{if .AllowMerge}} {{/* user is allowed to merge */}}
198198
{{$prUnit := .Repository.MustGetUnit $.Context $.UnitTypePullRequests}}
199199
{{$approvers := (.Issue.PullRequest.GetApprovers ctx)}}
200-
{{if or $prUnit.PullRequestsConfig.AllowMerge $prUnit.PullRequestsConfig.AllowRebase $prUnit.PullRequestsConfig.AllowRebaseMerge $prUnit.PullRequestsConfig.AllowSquash}}
200+
{{if or $prUnit.PullRequestsConfig.AllowMerge $prUnit.PullRequestsConfig.AllowRebase $prUnit.PullRequestsConfig.AllowRebaseMerge $prUnit.PullRequestsConfig.AllowSquash $prUnit.PullRequestsConfig.AllowFastForwardOnly}}
201201
{{$hasPendingPullRequestMergeTip := ""}}
202202
{{if .HasPendingPullRequestMerge}}
203203
{{$createdPRMergeStr := TimeSinceUnix .PendingPullRequestMerge.CreatedUnix ctx.Locale}}
@@ -268,6 +268,13 @@
268268
'mergeMessageFieldText': {{.GetCommitMessages}} + defaultSquashMergeMessage,
269269
'hideAutoMerge': generalHideAutoMerge,
270270
},
271+
{
272+
'name': 'fast-forward-only',
273+
'allowed': {{and $prUnit.PullRequestsConfig.AllowFastForwardOnly (eq .Issue.PullRequest.CommitsBehind 0)}},
274+
'textDoMerge': {{$.locale.Tr "repo.pulls.fast_forward_only_merge_pull_request"}},
275+
'hideMergeMessageTexts': true,
276+
'hideAutoMerge': generalHideAutoMerge,
277+
},
271278
{
272279
'name': 'manually-merged',
273280
'allowed': {{$prUnit.PullRequestsConfig.AllowManualMerge}},

‎templates/repo/settings/options.tmpl

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,12 @@
517517
<label>{{ctx.Locale.Tr "repo.pulls.squash_merge_pull_request"}}</label>
518518
</div>
519519
</div>
520+
<div class="field">
521+
<div class="ui checkbox">
522+
<input name="pulls_allow_fast_forward_only" type="checkbox" {{if or (not $pullRequestEnabled) ($prUnit.PullRequestsConfig.AllowFastForwardOnly)}}checked{{end}}>
523+
<label>{{.locale.Tr "repo.pulls.fast_forward_only_merge_pull_request"}}</label>
524+
</div>
525+
</div>
520526
<div class="field">
521527
<div class="ui checkbox">
522528
<input name="pulls_allow_manual_merge" type="checkbox" {{if or (not $pullRequestEnabled) ($prUnit.PullRequestsConfig.AllowManualMerge)}}checked{{end}}>
@@ -534,6 +540,7 @@
534540
<option value="rebase" {{if or (not $pullRequestEnabled) (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "rebase")}}selected{{end}}>{{ctx.Locale.Tr "repo.pulls.rebase_merge_pull_request"}}</option>
535541
<option value="rebase-merge" {{if or (not $pullRequestEnabled) (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "rebase-merge")}}selected{{end}}>{{ctx.Locale.Tr "repo.pulls.rebase_merge_commit_pull_request"}}</option>
536542
<option value="squash" {{if or (not $pullRequestEnabled) (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "squash")}}selected{{end}}>{{ctx.Locale.Tr "repo.pulls.squash_merge_pull_request"}}</option>
543+
<option value="fast-forward-only" {{if or (not $pullRequestEnabled) (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "fast-forward-only")}}selected{{end}}>{{ctx.Locale.Tr "repo.pulls.fast_forward_only_merge_pull_request"}}</option>
537544
</select>{{svg "octicon-triangle-down" 14 "dropdown icon"}}
538545
<div class="default text">
539546
{{if (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "merge")}}
@@ -548,12 +555,16 @@
548555
{{if (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "squash")}}
549556
{{ctx.Locale.Tr "repo.pulls.squash_merge_pull_request"}}
550557
{{end}}
558+
{{if (eq $prUnit.PullRequestsConfig.DefaultMergeStyle "fast-forward-only")}}
559+
{{.locale.Tr "repo.pulls.fast_forward_only_merge_pull_request"}}
560+
{{end}}
551561
</div>
552562
<div class="menu">
553563
<div class="item" data-value="merge">{{ctx.Locale.Tr "repo.pulls.merge_pull_request"}}</div>
554564
<div class="item" data-value="rebase">{{ctx.Locale.Tr "repo.pulls.rebase_merge_pull_request"}}</div>
555565
<div class="item" data-value="rebase-merge">{{ctx.Locale.Tr "repo.pulls.rebase_merge_commit_pull_request"}}</div>
556566
<div class="item" data-value="squash">{{ctx.Locale.Tr "repo.pulls.squash_merge_pull_request"}}</div>
567+
<div class="item" data-value="fast-forward-only">{{ctx.Locale.Tr "repo.pulls.fast_forward_only_merge_pull_request"}}</div>
557568
</div>
558569
</div>
559570
</div>

‎templates/swagger/v1_json.tmpl

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/integration/api_repo_edit_test.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ func getRepoEditOptionFromRepo(repo *repo_model.Repository) *api.EditRepoOption
6565
allowRebase := false
6666
allowRebaseMerge := false
6767
allowSquash := false
68+
allowFastForwardOnly := false
6869
if unit, err := repo.GetUnit(db.DefaultContext, unit_model.TypePullRequests); err == nil {
6970
config := unit.PullRequestsConfig()
7071
hasPullRequests = true
@@ -73,6 +74,7 @@ func getRepoEditOptionFromRepo(repo *repo_model.Repository) *api.EditRepoOption
7374
allowRebase = config.AllowRebase
7475
allowRebaseMerge = config.AllowRebaseMerge
7576
allowSquash = config.AllowSquash
77+
allowFastForwardOnly = config.AllowFastForwardOnly
7678
}
7779
archived := repo.IsArchived
7880
return &api.EditRepoOption{
@@ -92,6 +94,7 @@ func getRepoEditOptionFromRepo(repo *repo_model.Repository) *api.EditRepoOption
9294
AllowRebase: &allowRebase,
9395
AllowRebaseMerge: &allowRebaseMerge,
9496
AllowSquash: &allowSquash,
97+
AllowFastForwardOnly: &allowFastForwardOnly,
9598
Archived: &archived,
9699
}
97100
}

0 commit comments

Comments
 (0)