From 9353722d12e36c4d8e641b77be7e71382e0bb158 Mon Sep 17 00:00:00 2001 From: Brecht Van Lommel Date: Sun, 29 Jan 2023 23:56:19 +0100 Subject: [PATCH 1/4] Merge message template support for rebase without merge commit Use `default_merge_message/REBASE_TEMPLATE.md` for amending the message of the last commit in the list of commits that was merged. Previously this template was mentioned in the documentation but not actually used. In this template additional variables `CommitTitle` and `CommitBody` are available, for the title and body of every commit. Ideally the message of every commit would be updated using the template, but doing an interactive rebase or merging commits one by one is complicated, so that is left as a future improvement. --- .../usage/merge-message-templates.en-us.md | 7 ++ services/pull/merge.go | 113 +++++++++++++++--- 2 files changed, 105 insertions(+), 15 deletions(-) diff --git a/docs/content/doc/usage/merge-message-templates.en-us.md b/docs/content/doc/usage/merge-message-templates.en-us.md index c30ac1bfeb40f..ba6087e412825 100644 --- a/docs/content/doc/usage/merge-message-templates.en-us.md +++ b/docs/content/doc/usage/merge-message-templates.en-us.md @@ -46,3 +46,10 @@ You can use the following variables enclosed in `${}` inside these templates whi - PullRequestIndex: Pull request's index number - PullRequestReference: Pull request's reference char with index number. i.e. #1, !2 - ClosingIssues: return a string contains all issues which will be closed by this pull request i.e. `close #1, close #2` + +## Rebase + +When rebasing without a merge commit, `REBASE_TEMPLATE.md` modifies the message of the last commit. The following additional variables are available in this template: + +- CommitTitle: Commit's title +- CommitBody: Commits's body text diff --git a/services/pull/merge.go b/services/pull/merge.go index 7ffbdb78b0207..9997bace4b3ae 100644 --- a/services/pull/merge.go +++ b/services/pull/merge.go @@ -38,8 +38,8 @@ import ( issue_service "code.gitea.io/gitea/services/issue" ) -// GetDefaultMergeMessage returns default message used when merging pull request -func GetDefaultMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle) (message, body string, err error) { +// Compose message used when merging pull request. +func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle, commitTitle, commitBody string) (message, body string, err error) { if err := pr.LoadHeadRepo(ctx); err != nil { return "", "", err } @@ -70,6 +70,8 @@ func GetDefaultMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr if err != nil { if !git.IsErrNotExist(err) { return "", "", err + } else if mergeStyle == repo_model.MergeStyleRebase { + return "", "", nil } } else { vars := map[string]string{ @@ -85,6 +87,10 @@ func GetDefaultMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr "PullRequestIndex": strconv.FormatInt(pr.Index, 10), "PullRequestReference": fmt.Sprintf("%s%d", issueReference, pr.Index), } + if mergeStyle == repo_model.MergeStyleRebase { + vars["CommitTitle"] = commitTitle + vars["CommitBody"] = commitBody + } if pr.HeadRepo != nil { vars["HeadRepoOwnerName"] = pr.HeadRepo.OwnerName vars["HeadRepoName"] = pr.HeadRepo.Name @@ -138,6 +144,11 @@ func expandDefaultMergeMessage(template string, vars map[string]string) (message return os.Expand(message, mapping), os.Expand(body, mapping) } +// GetDefaultMergeMessage returns default message used when merging pull request. +func GetDefaultMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle) (message, body string, err error) { + return getMergeMessage(ctx, baseGitRepo, pr, mergeStyle, "", "") +} + // Merge merges pull request to base repository. // Caller should check PR is ready to be merged (review and status checks) func Merge(ctx context.Context, pr *issues_model.PullRequest, doer *user_model.User, baseGitRepo *git.Repository, mergeStyle repo_model.MergeStyle, expectedHeadCommitID, message string, wasAutoMerged bool) error { @@ -491,24 +502,24 @@ func rawMerge(ctx context.Context, pr *issues_model.PullRequest, doer *user_mode outbuf.Reset() errbuf.Reset() - cmd := git.NewCommand(ctx, "merge") if mergeStyle == repo_model.MergeStyleRebase { - cmd.AddArguments("--ff-only") + if err := rebaseMerge(ctx, pr, tmpBasePath, stagingBranch); err != nil { + return "", err + } } else { - cmd.AddArguments("--no-ff", "--no-commit") - } - cmd.AddDynamicArguments(stagingBranch) + // Prepare merge with commit + cmd := git.NewCommand(ctx, "merge", "--no-ff", "--no-commit").AddDynamicArguments(stagingBranch) - // Prepare merge with commit - if err := runMergeCommand(pr, mergeStyle, cmd, tmpBasePath); err != nil { - log.Error("Unable to merge staging into base: %v", err) - return "", err - } - if mergeStyle == repo_model.MergeStyleRebaseMerge { - if err := commitAndSignNoAuthor(ctx, pr, message, signArg, tmpBasePath, env); err != nil { - log.Error("Unable to make final commit: %v", err) + if err := runMergeCommand(pr, mergeStyle, cmd, tmpBasePath); err != nil { + log.Error("Unable to merge staging into base: %v", err) return "", err } + if mergeStyle == repo_model.MergeStyleRebaseMerge { + if err := commitAndSignNoAuthor(ctx, pr, message, signArg, tmpBasePath, env); err != nil { + log.Error("Unable to make final commit: %v", err) + return "", err + } + } } case repo_model.MergeStyleSquash: // Merge with squash @@ -649,6 +660,78 @@ func rawMerge(ctx context.Context, pr *issues_model.PullRequest, doer *user_mode return mergeCommitID, nil } +// Compose message to amend commit in rebase merge of pull request. +func getRebaseAmendMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, tmpBasePath string) (message string, err error) { + // Get existing commit message. + var commitMessage strings.Builder + cmd := git.NewCommand(ctx, "show", "--format=%B", "-s") + if err := cmd.Run(&git.RunOpts{Dir: tmpBasePath, Stdout: &commitMessage}); err != nil { + return "", err + } + + commitTitle, commitBody, _ := strings.Cut(commitMessage.String(), "\n") + commitTitle = strings.TrimSpace(commitTitle) + commitBody = strings.TrimSpace(commitBody) + + message, body, err := getMergeMessage(ctx, baseGitRepo, pr, repo_model.MergeStyleRebase, commitTitle, commitBody) + if err != nil || message == "" { + return "", err + } + + if len(body) > 0 { + message = message + "\n\n" + body + } + return message, err +} + +// Perform rebase merge without merge commits. +func rebaseMerge(ctx context.Context, pr *issues_model.PullRequest, tmpBasePath, stagingBranch string) error { + baseHeadSHA, err := git.GetFullCommitID(ctx, tmpBasePath, "HEAD") + if err != nil { + return fmt.Errorf("Failed to get full commit id for HEAD: %w", err) + } + + cmd := git.NewCommand(ctx, "merge", "--ff-only").AddDynamicArguments(stagingBranch) + if err := runMergeCommand(pr, repo_model.MergeStyleRebase, cmd, tmpBasePath); err != nil { + log.Error("Unable to merge staging into base: %v", err) + return err + } + + // Check if anything actually changed before we amend the message, fast forward can skip commits. + newMergeHeadSHA, err := git.GetFullCommitID(ctx, tmpBasePath, "HEAD") + if err != nil { + return fmt.Errorf("Failed to get full commit id for HEAD: %w", err) + } + if baseHeadSHA == newMergeHeadSHA { + return nil + } + + // Original repo to read template from. + baseGitRepo, err := git.OpenRepository(ctx, pr.BaseRepo.RepoPath()) + if err != nil { + log.Error("Unable to get Git repo for rebase: %v", err) + return err + } + defer baseGitRepo.Close() + + // Amend last commit message based on template, if one exists + newMessage, err := getRebaseAmendMessage(ctx, baseGitRepo, pr, tmpBasePath) + if err != nil { + log.Error("Unable to get commit message for amend: %v", err) + return err + } + + if newMessage != "" { + cmdAmend := git.NewCommand(ctx, "commit", "--amend", "-m").AddDynamicArguments(newMessage) + if err := cmdAmend.Run(&git.RunOpts{Dir: tmpBasePath}); err != nil { + log.Error("Unable to amend commit message: %v", err) + return err + } + } + + return nil +} + func commitAndSignNoAuthor(ctx context.Context, pr *issues_model.PullRequest, message string, signArg git.CmdArg, tmpBasePath string, env []string) error { var outbuf, errbuf strings.Builder if signArg == "" { From 6b8a3bcec96d06c56332c2caf2f0c49c24dda4c3 Mon Sep 17 00:00:00 2001 From: Brecht Van Lommel Date: Sun, 21 May 2023 17:34:49 +0200 Subject: [PATCH 2/4] Address comments --- services/pull/merge.go | 13 +++++-------- services/pull/merge_rebase.go | 5 ++--- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/services/pull/merge.go b/services/pull/merge.go index ba3a90696280d..412507ba5ce00 100644 --- a/services/pull/merge.go +++ b/services/pull/merge.go @@ -35,7 +35,7 @@ import ( ) // Compose message used when merging pull request. -func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle, commitTitle, commitBody string) (message, body string, err error) { +func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle, extraVars map[string]string) (message, body string, err error) { if err := pr.LoadBaseRepo(ctx); err != nil { return "", "", err } @@ -62,8 +62,6 @@ func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issue if err != nil { if !git.IsErrNotExist(err) { return "", "", err - } else if mergeStyle == repo_model.MergeStyleRebase { - return "", "", nil } } else { vars := map[string]string{ @@ -79,14 +77,13 @@ func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issue "PullRequestIndex": strconv.FormatInt(pr.Index, 10), "PullRequestReference": fmt.Sprintf("%s%d", issueReference, pr.Index), } - if mergeStyle == repo_model.MergeStyleRebase { - vars["CommitTitle"] = commitTitle - vars["CommitBody"] = commitBody - } if pr.HeadRepo != nil { vars["HeadRepoOwnerName"] = pr.HeadRepo.OwnerName vars["HeadRepoName"] = pr.HeadRepo.Name } + for extraKey, extraValue := range extraVars { + vars[extraKey] = extraValue + } refs, err := pr.ResolveCrossReferences(ctx) if err == nil { closeIssueIndexes := make([]string, 0, len(refs)) @@ -141,7 +138,7 @@ func expandDefaultMergeMessage(template string, vars map[string]string) (message // GetDefaultMergeMessage returns default message used when merging pull request func GetDefaultMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle) (message, body string, err error) { - return getMergeMessage(ctx, baseGitRepo, pr, mergeStyle, "", "") + return getMergeMessage(ctx, baseGitRepo, pr, mergeStyle, map[string]string{}) } // Merge merges pull request to base repository. diff --git a/services/pull/merge_rebase.go b/services/pull/merge_rebase.go index 2b5485a9f7802..e569eedb3e878 100644 --- a/services/pull/merge_rebase.go +++ b/services/pull/merge_rebase.go @@ -22,10 +22,9 @@ func getRebaseAmendMessage(ctx *mergeContext, baseGitRepo *git.Repository) (mess } commitTitle, commitBody, _ := strings.Cut(commitMessage.String(), "\n") - commitTitle = strings.TrimSpace(commitTitle) - commitBody = strings.TrimSpace(commitBody) + extraVars := map[string]string{"CommitTitle": strings.TrimSpace(commitTitle), "CommitBody": strings.TrimSpace(commitBody)} - message, body, err := getMergeMessage(ctx, baseGitRepo, ctx.pr, repo_model.MergeStyleRebase, commitTitle, commitBody) + message, body, err := getMergeMessage(ctx, baseGitRepo, ctx.pr, repo_model.MergeStyleRebase, extraVars) if err != nil || message == "" { return "", err } From d068674f9d5c21f65ad4fc293f7f32917a45947f Mon Sep 17 00:00:00 2001 From: Brecht Van Lommel Date: Sun, 21 May 2023 18:23:34 +0200 Subject: [PATCH 3/4] Address comments --- services/pull/merge.go | 4 ++-- services/pull/merge_rebase.go | 8 +++----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/services/pull/merge.go b/services/pull/merge.go index 412507ba5ce00..85bb90b853899 100644 --- a/services/pull/merge.go +++ b/services/pull/merge.go @@ -34,7 +34,7 @@ import ( issue_service "code.gitea.io/gitea/services/issue" ) -// Compose message used when merging pull request. +// getMergeMessage composes the message used when merging a pull request. func getMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle, extraVars map[string]string) (message, body string, err error) { if err := pr.LoadBaseRepo(ctx); err != nil { return "", "", err @@ -138,7 +138,7 @@ func expandDefaultMergeMessage(template string, vars map[string]string) (message // GetDefaultMergeMessage returns default message used when merging pull request func GetDefaultMergeMessage(ctx context.Context, baseGitRepo *git.Repository, pr *issues_model.PullRequest, mergeStyle repo_model.MergeStyle) (message, body string, err error) { - return getMergeMessage(ctx, baseGitRepo, pr, mergeStyle, map[string]string{}) + return getMergeMessage(ctx, baseGitRepo, pr, mergeStyle, nil) } // Merge merges pull request to base repository. diff --git a/services/pull/merge_rebase.go b/services/pull/merge_rebase.go index e569eedb3e878..6abe3b9604ec8 100644 --- a/services/pull/merge_rebase.go +++ b/services/pull/merge_rebase.go @@ -12,12 +12,11 @@ import ( "code.gitea.io/gitea/modules/log" ) -// Compose message to amend commit in rebase merge of pull request. +// getRebaseAmendMessage composes the message to amend commits in rebase merge of a pull request. func getRebaseAmendMessage(ctx *mergeContext, baseGitRepo *git.Repository) (message string, err error) { // Get existing commit message. var commitMessage strings.Builder - cmd := git.NewCommand(ctx, "show", "--format=%B", "-s") - if err := cmd.Run(&git.RunOpts{Dir: ctx.tmpBasePath, Stdout: &commitMessage}); err != nil { + if err := git.NewCommand(ctx, "show", "--format=%B", "-s").Run(&git.RunOpts{Dir: ctx.tmpBasePath, Stdout: &commitMessage}); err != nil { return "", err } @@ -73,8 +72,7 @@ func doMergeRebaseFastForward(ctx *mergeContext) error { } if newMessage != "" { - cmdAmend := git.NewCommand(ctx, "commit", "--amend").AddOptionFormat("--message=%s", newMessage) - if err := cmdAmend.Run(&git.RunOpts{Dir: ctx.tmpBasePath}); err != nil { + if err := git.NewCommand(ctx, "commit", "--amend").AddOptionFormat("--message=%s", newMessage).Run(&git.RunOpts{Dir: ctx.tmpBasePath}); err != nil { log.Error("Unable to amend commit message: %v", err) return err } From d7c44f773d8cd114e9d02f702101f988616c2dd1 Mon Sep 17 00:00:00 2001 From: Brecht Van Lommel Date: Sun, 21 May 2023 18:49:49 +0200 Subject: [PATCH 4/4] Use RunStdString --- services/pull/merge_rebase.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/services/pull/merge_rebase.go b/services/pull/merge_rebase.go index 6abe3b9604ec8..a88f805ef0252 100644 --- a/services/pull/merge_rebase.go +++ b/services/pull/merge_rebase.go @@ -15,12 +15,12 @@ import ( // getRebaseAmendMessage composes the message to amend commits in rebase merge of a pull request. func getRebaseAmendMessage(ctx *mergeContext, baseGitRepo *git.Repository) (message string, err error) { // Get existing commit message. - var commitMessage strings.Builder - if err := git.NewCommand(ctx, "show", "--format=%B", "-s").Run(&git.RunOpts{Dir: ctx.tmpBasePath, Stdout: &commitMessage}); err != nil { + commitMessage, _, err := git.NewCommand(ctx, "show", "--format=%B", "-s").RunStdString(&git.RunOpts{Dir: ctx.tmpBasePath}) + if err != nil { return "", err } - commitTitle, commitBody, _ := strings.Cut(commitMessage.String(), "\n") + commitTitle, commitBody, _ := strings.Cut(commitMessage, "\n") extraVars := map[string]string{"CommitTitle": strings.TrimSpace(commitTitle), "CommitBody": strings.TrimSpace(commitBody)} message, body, err := getMergeMessage(ctx, baseGitRepo, ctx.pr, repo_model.MergeStyleRebase, extraVars)