Pre-populate default merge commit message if no body was provided

cristiand391 · mislav · commit f75bd7280fdd · 2021-02-16T16:01:22.000+01:00
diff --git a/api/queries_pr.go b/api/queries_pr.go
@@ -88,6 +88,8 @@ type PullRequest struct {
 	ReactionGroups ReactionGroups
 	Reviews        PullRequestReviews
 	ReviewRequests ReviewRequests
+
+	ViewerMergeBodyText string
 }
 
 type ReviewRequests struct {
@@ -584,6 +586,7 @@ func PullRequestByNumber(client *Client, repo ghrepo.Interface, number int) (*Pu
 				milestone{
 					title
 				}
+				viewerMergeBodyText
 				` + commentsFragment() + `
 				` + reactionGroupsFragment() + `
 			}
diff --git a/pkg/cmd/pr/merge/merge.go b/pkg/cmd/pr/merge/merge.go
@@ -32,8 +32,7 @@ type MergeOptions struct {
 	DeleteBranch bool
 	MergeMethod  api.PullRequestMergeMethod
 
-	Body         string
-	BodyProvided bool
+	Body string
 
 	IsDeleteBranchIndicated bool
 	CanDeleteLocalBranch    bool
@@ -99,10 +98,6 @@ func NewCmdMerge(f *cmdutil.Factory, runF func(*MergeOptions) error) *cobra.Comm
 			opts.IsDeleteBranchIndicated = cmd.Flags().Changed("delete-branch")
 			opts.CanDeleteLocalBranch = !cmd.Flags().Changed("repo")
 
-			if cmd.Flags().Changed("body") {
-				opts.BodyProvided = true
-			}
-
 			if runF != nil {
 				return runF(opts)
 			}
@@ -169,7 +164,7 @@ func mergeRun(opts *MergeOptions) error {
 				return err
 			}
 
-			allowEditMsg := (mergeMethod != api.PullRequestMergeMethodRebase) && !opts.BodyProvided
+			allowEditMsg := mergeMethod != api.PullRequestMergeMethodRebase
 
 			action, err := confirmSurvey(allowEditMsg)
 			if err != nil {
@@ -183,12 +178,19 @@ func mergeRun(opts *MergeOptions) error {
 					return err
 				}
 
-				msg, err := commitMsgSurvey(editorCommand)
+				if opts.Body == "" {
+					if mergeMethod == api.PullRequestMergeMethodMerge {
+						opts.Body = pr.Title
+					} else {
+						opts.Body = pr.ViewerMergeBodyText
+					}
+				}
+
+				msg, err := commitMsgSurvey(opts.Body, editorCommand)
 				if err != nil {
 					return err
 				}
 				opts.Body = msg
-				opts.BodyProvided = true
 
 				action, err = confirmSurvey(false)
 				if err != nil {
@@ -202,7 +204,7 @@ func mergeRun(opts *MergeOptions) error {
 		}
 
 		var body *string
-		if opts.BodyProvided {
+		if opts.Body != "" {
 			body = &opts.Body
 		}
 
@@ -378,13 +380,15 @@ func confirmSurvey(allowEditMsg bool) (shared.Action, error) {
 	}
 }
 
-func commitMsgSurvey(editorCommand string) (string, error) {
+func commitMsgSurvey(msg string, editorCommand string) (string, error) {
 	var result string
 	q := &surveyext.GhEditor{
 		EditorCommand: editorCommand,
 		Editor: &survey.Editor{
-			Message:  "Body",
-			FileName: "*.md",
+			Message:       "Body",
+			AppendDefault: true,
+			Default:       msg,
+			FileName:      "*.md",
 		},
 	}
 	err := prompt.SurveyAskOne(q, &result)
diff --git a/pkg/cmd/pr/merge/merge_test.go b/pkg/cmd/pr/merge/merge_test.go
@@ -71,7 +71,6 @@ func Test_NewCmdMerge(t *testing.T) {
 				MergeMethod:             api.PullRequestMergeMethodMerge,
 				InteractiveMode:         true,
 				Body:                    "cool",
-				BodyProvided:            true,
 			},
 		},
 		{
@@ -139,7 +138,6 @@ func Test_NewCmdMerge(t *testing.T) {
 			assert.Equal(t, tt.want.MergeMethod, opts.MergeMethod)
 			assert.Equal(t, tt.want.InteractiveMode, opts.InteractiveMode)
 			assert.Equal(t, tt.want.Body, opts.Body)
-			assert.Equal(t, tt.want.BodyProvided, opts.BodyProvided)
 		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,8 @@ type PullRequest struct {`
`88`	`88`	`ReactionGroups ReactionGroups`
`89`	`89`	`Reviews PullRequestReviews`
`90`	`90`	`ReviewRequests ReviewRequests`
	`91`	`+`
	`92`	`+ ViewerMergeBodyText string`
`91`	`93`	`}`
`92`	`94`
`93`	`95`	`type ReviewRequests struct {`
`@@ -584,6 +586,7 @@ func PullRequestByNumber(client Client, repo ghrepo.Interface, number int) (Pu`
`584`	`586`	`milestone{`
`585`	`587`	`title`
`586`	`588`	`}`
	`589`	`+ viewerMergeBodyText`
`587`	`590`	` + commentsFragment() + `
`588`	`591`	` + reactionGroupsFragment() + `
`589`	`592`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,6 @@ func Test_NewCmdMerge(t *testing.T) {`
`71`	`71`	`MergeMethod: api.PullRequestMergeMethodMerge,`
`72`	`72`	`InteractiveMode: true,`
`73`	`73`	`Body: "cool",`
`74`		`- BodyProvided: true,`
`75`	`74`	`},`
`76`	`75`	`},`
`77`	`76`	`{`
`@@ -139,7 +138,6 @@ func Test_NewCmdMerge(t *testing.T) {`
`139`	`138`	`assert.Equal(t, tt.want.MergeMethod, opts.MergeMethod)`
`140`	`139`	`assert.Equal(t, tt.want.InteractiveMode, opts.InteractiveMode)`
`141`	`140`	`assert.Equal(t, tt.want.Body, opts.Body)`
`142`		`- assert.Equal(t, tt.want.BodyProvided, opts.BodyProvided)`
`143`	`141`	`})`
`144`	`142`	`}`
`145`	`143`	`}`