Skip to content

Append to existing trailers in generated squash commit message #15980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
techknowlogick merged 12 commits into from
Jun 25, 2021
Merged

Append to existing trailers in generated squash commit message #15980

Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d0bd605
Remove superfluous newline before Co-authored-by trailers
jpraet May 24, 2021
6f5eb18
Append to existing PR description trailer section
jpraet May 24, 2021
48552b3
Reuse compiled regexp
jpraet May 26, 2021
2853bdb
Merge branch 'main' into squash-append-to-existing-trailers
jpraet May 27, 2021
61ffb36
Merge branch 'main' into squash-append-to-existing-trailers
jpraet Jun 3, 2021
94333e2
Merge branch 'main' into squash-append-to-existing-trailers
jpraet Jun 19, 2021
45b1b78
Simplify regex and deal with trailing \n in PR description
jpraet Jun 21, 2021
a84e87e
Add tests for CommitMessageTrailersPattern
jpraet Jun 21, 2021
f7843f6
Merge branch 'main' into squash-append-to-existing-trailers
jpraet Jun 24, 2021
ee89e2a
Update services/pull/pull_test.go
zeripath Jun 25, 2021
9b5a80e
Merge branch 'main' into squash-append-to-existing-trailers
lunny Jun 25, 2021
0061541
Merge branch 'main' into squash-append-to-existing-trailers
techknowlogick Jun 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions services/pull/pull.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"bytes"
"context"
"fmt"
"regexp"
"strings"
"time"

Expand Down Expand Up @@ -516,6 +517,8 @@ func CloseRepoBranchesPulls(doer *models.User, repo *models.Repository) error {
return nil
}

var commitMessageTrailersPattern = regexp.MustCompile(`(?:^|\n\n)(?:[\w-]+: [^\n]+\n*)+$`)
Copy link
Contributor

@zeripath zeripath Jun 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK testing from git interpret-trailers I think this needs to be, at least:

Suggested change
var commitMessageTrailersPattern = regexp.MustCompile(`(?:^|\n\n)(?:[\w-]+: [^\n]+\n*)+$`)
var commitMessageTrailersPattern = regexp.MustCompile(`(?:^|\n\n)(?:[\w-]+[:=][^\n]+\n)*(?:[\w-]+: [^\n]+)\n*$`)

However trailers can be folded, see https://git-scm.com/docs/git-interpret-trailers

When reading trailers, there can be whitespaces after the token, the separator and the value. There can also be whitespaces inside the token and the value. The value may be split over multiple lines with each subsequent line starting with whitespace, like the "folding" in RFC 822.

Which would make this:

Suggested change
var commitMessageTrailersPattern = regexp.MustCompile(`(?:^|\n\n)(?:[\w-]+: [^\n]+\n*)+$`)
var commitMessageTrailersPattern = regexp.MustCompile(`(?:^|\n\n)(?:[\w-]+[:=][^\n]+\n(?: [^\n]*\n)*)*(?:[\w-]+: [^\n]+(?:\n [^\n]*)*)\n*$`)

(I think)

Copy link
Contributor

@zeripath zeripath Jun 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

echo -n 'Fix #1546                                                                         [19:26:27]

Signed-off-by: Not a trailer

Signed-off-by:Alice <[email protected]>
Signed-off-by:   Bob <[email protected]>
' | git interpret-trailers --parse

echo -n 'Fix #1546                                                                         [19:26:27]

Signed-off-by:Not a trailer

Signed-off-by:Alice <[email protected]>
Signed-off-by:   Bob <[email protected]>' | git interpret-trailers --parse

echo -n 'Fix #1546

Signed-off-by:Not a trailer

Signed-off-by:Alice <[email protected]>
Signed-off-by:   Bob <[email protected]>


' | git interpret-trailers --parse

echo -n 'Fix #1546

Signed-off-by:Not a trailer

Signed-off-by:Alice <[email protected]>
Folded: This is a folded value
 with folded results
   preceding spaces?
Signed-off-by:   Bob <[email protected]>' | git interpret-trailers --parse


// GetSquashMergeCommitMessages returns the commit messages between head and merge base (if there is one)
func GetSquashMergeCommitMessages(pr *models.PullRequest) string {
if err := pr.LoadIssue(); err != nil {
Expand Down Expand Up @@ -571,10 +574,13 @@ func GetSquashMergeCommitMessages(pr *models.PullRequest) string {
stringBuilder := strings.Builder{}

if !setting.Repository.PullRequest.PopulateSquashCommentWithCommitMessages {
stringBuilder.WriteString(pr.Issue.Content)
message := strings.TrimSpace(pr.Issue.Content)
stringBuilder.WriteString(message)
if stringBuilder.Len() > 0 {
stringBuilder.WriteRune('\n')
stringBuilder.WriteRune('\n')
if !commitMessageTrailersPattern.MatchString(message) {
stringBuilder.WriteRune('\n')
}
}
}

Expand Down Expand Up @@ -645,13 +651,6 @@ func GetSquashMergeCommitMessages(pr *models.PullRequest) string {
}
}

if len(authors) > 0 {
if _, err := stringBuilder.WriteRune('\n'); err != nil {
log.Error("Unable to write to string builder Error: %v", err)
return ""
}
}

for _, author := range authors {
if _, err := stringBuilder.Write([]byte("Co-authored-by: ")); err != nil {
log.Error("Unable to write to string builder Error: %v", err)
Expand Down