From f19da14c34f3a86a77b45de77f48109fa5edcf78 Mon Sep 17 00:00:00 2001 From: a1012112796 <1012112796@qq.com> Date: Fri, 29 Jan 2021 16:57:45 +0800 Subject: [PATCH] enhancement: add signoff option in commit form (#14516) Signed-off-by: a1012112796 <1012112796@qq.com> --- modules/forms/repo_form.go | 3 +++ modules/repofiles/delete.go | 5 +++-- modules/repofiles/temp_repo.go | 13 ++++++++++--- modules/repofiles/update.go | 5 +++-- modules/repofiles/upload.go | 3 ++- modules/structs/repo_file.go | 2 ++ options/locale/locale_en-US.ini | 1 + routers/api/v1/repo/file.go | 3 +++ routers/repo/editor.go | 3 +++ templates/repo/editor/commit_form.tmpl | 6 ++++++ templates/swagger/v1_json.tmpl | 15 +++++++++++++++ 11 files changed, 51 insertions(+), 8 deletions(-) diff --git a/modules/forms/repo_form.go b/modules/forms/repo_form.go index 4a478c7d35..4d37ab072b 100644 --- a/modules/forms/repo_form.go +++ b/modules/forms/repo_form.go @@ -698,6 +698,7 @@ type EditRepoFileForm struct { CommitChoice string `binding:"Required;MaxSize(50)"` NewBranchName string `binding:"GitRefName;MaxSize(100)"` LastCommit string + Signoff bool } // Validate validates the fields @@ -733,6 +734,7 @@ type UploadRepoFileForm struct { CommitChoice string `binding:"Required;MaxSize(50)"` NewBranchName string `binding:"GitRefName;MaxSize(100)"` Files []string + Signoff bool } // Validate validates the fields @@ -766,6 +768,7 @@ type DeleteRepoFileForm struct { CommitChoice string `binding:"Required;MaxSize(50)"` NewBranchName string `binding:"GitRefName;MaxSize(100)"` LastCommit string + Signoff bool } // Validate validates the fields diff --git a/modules/repofiles/delete.go b/modules/repofiles/delete.go index 8343776c47..2b8ddf3cc2 100644 --- a/modules/repofiles/delete.go +++ b/modules/repofiles/delete.go @@ -25,6 +25,7 @@ type DeleteRepoFileOptions struct { Author *IdentityOptions Committer *IdentityOptions Dates *CommitDateOptions + Signoff bool } // DeleteRepoFile deletes a file in the given repository @@ -199,9 +200,9 @@ func DeleteRepoFile(repo *models.Repository, doer *models.User, opts *DeleteRepo // Now commit the tree var commitHash string if opts.Dates != nil { - commitHash, err = t.CommitTreeWithDate(author, committer, treeHash, message, opts.Dates.Author, opts.Dates.Committer) + commitHash, err = t.CommitTreeWithDate(author, committer, treeHash, message, opts.Signoff, opts.Dates.Author, opts.Dates.Committer) } else { - commitHash, err = t.CommitTree(author, committer, treeHash, message) + commitHash, err = t.CommitTree(author, committer, treeHash, message, opts.Signoff) } if err != nil { return nil, err diff --git a/modules/repofiles/temp_repo.go b/modules/repofiles/temp_repo.go index a02bba65e9..99c62a16c6 100644 --- a/modules/repofiles/temp_repo.go +++ b/modules/repofiles/temp_repo.go @@ -185,12 +185,12 @@ func (t *TemporaryUploadRepository) GetLastCommitByRef(ref string) (string, erro } // CommitTree creates a commit from a given tree for the user with provided message -func (t *TemporaryUploadRepository) CommitTree(author, committer *models.User, treeHash string, message string) (string, error) { - return t.CommitTreeWithDate(author, committer, treeHash, message, time.Now(), time.Now()) +func (t *TemporaryUploadRepository) CommitTree(author, committer *models.User, treeHash string, message string, signoff bool) (string, error) { + return t.CommitTreeWithDate(author, committer, treeHash, message, signoff, time.Now(), time.Now()) } // CommitTreeWithDate creates a commit from a given tree for the user with provided message -func (t *TemporaryUploadRepository) CommitTreeWithDate(author, committer *models.User, treeHash string, message string, authorDate, committerDate time.Time) (string, error) { +func (t *TemporaryUploadRepository) CommitTreeWithDate(author, committer *models.User, treeHash string, message string, signoff bool, authorDate, committerDate time.Time) (string, error) { authorSig := author.NewGitSig() committerSig := committer.NewGitSig() @@ -236,6 +236,13 @@ func (t *TemporaryUploadRepository) CommitTreeWithDate(author, committer *models } } + if signoff { + // Signed-off-by + _, _ = messageBytes.WriteString("\n") + _, _ = messageBytes.WriteString("Signed-off-by: ") + _, _ = messageBytes.WriteString(committerSig.String()) + } + env = append(env, "GIT_COMMITTER_NAME="+committerSig.Name, "GIT_COMMITTER_EMAIL="+committerSig.Email, diff --git a/modules/repofiles/update.go b/modules/repofiles/update.go index a1a9c624d7..0ee1ada34c 100644 --- a/modules/repofiles/update.go +++ b/modules/repofiles/update.go @@ -51,6 +51,7 @@ type UpdateRepoFileOptions struct { Author *IdentityOptions Committer *IdentityOptions Dates *CommitDateOptions + Signoff bool } func detectEncodingAndBOM(entry *git.TreeEntry, repo *models.Repository) (string, bool) { @@ -417,9 +418,9 @@ func CreateOrUpdateRepoFile(repo *models.Repository, doer *models.User, opts *Up // Now commit the tree var commitHash string if opts.Dates != nil { - commitHash, err = t.CommitTreeWithDate(author, committer, treeHash, message, opts.Dates.Author, opts.Dates.Committer) + commitHash, err = t.CommitTreeWithDate(author, committer, treeHash, message, opts.Signoff, opts.Dates.Author, opts.Dates.Committer) } else { - commitHash, err = t.CommitTree(author, committer, treeHash, message) + commitHash, err = t.CommitTree(author, committer, treeHash, message, opts.Signoff) } if err != nil { return nil, err diff --git a/modules/repofiles/upload.go b/modules/repofiles/upload.go index e3ec48ec0f..c261e188c1 100644 --- a/modules/repofiles/upload.go +++ b/modules/repofiles/upload.go @@ -24,6 +24,7 @@ type UploadRepoFileOptions struct { TreePath string Message string Files []string // In UUID format. + Signoff bool } type uploadInfo struct { @@ -143,7 +144,7 @@ func UploadRepoFiles(repo *models.Repository, doer *models.User, opts *UploadRep committer := doer // Now commit the tree - commitHash, err := t.CommitTree(author, committer, treeHash, opts.Message) + commitHash, err := t.CommitTree(author, committer, treeHash, opts.Message, opts.Signoff) if err != nil { return err } diff --git a/modules/structs/repo_file.go b/modules/structs/repo_file.go index c34923e389..71733c90e7 100644 --- a/modules/structs/repo_file.go +++ b/modules/structs/repo_file.go @@ -17,6 +17,8 @@ type FileOptions struct { Author Identity `json:"author"` Committer Identity `json:"committer"` Dates CommitDateOptions `json:"dates"` + // Add a Signed-off-by trailer by the committer at the end of the commit log message. + Signoff bool `json:"signoff"` } // CreateFileOptions options for creating files diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index 362b09e291..a7dae87cd8 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -874,6 +874,7 @@ editor.add = Add '%s' editor.update = Update '%s' editor.delete = Delete '%s' editor.commit_message_desc = Add an optional extended description… +editor.signoff_desc = Add a Signed-off-by trailer by the committer at the end of the commit log message. editor.commit_directly_to_this_branch = Commit directly to the %s branch. editor.create_new_branch = Create a new branch for this commit and start a pull request. editor.create_new_branch_np = Create a new branch for this commit. diff --git a/routers/api/v1/repo/file.go b/routers/api/v1/repo/file.go index 044d0fe565..2bd57f1460 100644 --- a/routers/api/v1/repo/file.go +++ b/routers/api/v1/repo/file.go @@ -235,6 +235,7 @@ func CreateFile(ctx *context.APIContext) { Author: apiOpts.Dates.Author, Committer: apiOpts.Dates.Committer, }, + Signoff: apiOpts.Signoff, } if opts.Dates.Author.IsZero() { opts.Dates.Author = time.Now() @@ -323,6 +324,7 @@ func UpdateFile(ctx *context.APIContext) { Author: apiOpts.Dates.Author, Committer: apiOpts.Dates.Committer, }, + Signoff: apiOpts.Signoff, } if opts.Dates.Author.IsZero() { opts.Dates.Author = time.Now() @@ -449,6 +451,7 @@ func DeleteFile(ctx *context.APIContext) { Author: apiOpts.Dates.Author, Committer: apiOpts.Dates.Committer, }, + Signoff: apiOpts.Signoff, } if opts.Dates.Author.IsZero() { opts.Dates.Author = time.Now() diff --git a/routers/repo/editor.go b/routers/repo/editor.go index 619912fef7..344174828e 100644 --- a/routers/repo/editor.go +++ b/routers/repo/editor.go @@ -240,6 +240,7 @@ func editFilePost(ctx *context.Context, form auth.EditRepoFileForm, isNewFile bo Message: message, Content: strings.ReplaceAll(form.Content, "\r", ""), IsNewFile: isNewFile, + Signoff: form.Signoff, }); err != nil { // This is where we handle all the errors thrown by repofiles.CreateOrUpdateRepoFile if git.IsErrNotExist(err) { @@ -442,6 +443,7 @@ func DeleteFilePost(ctx *context.Context) { NewBranch: branchName, TreePath: ctx.Repo.TreePath, Message: message, + Signoff: form.Signoff, }); err != nil { // This is where we handle all the errors thrown by repofiles.DeleteRepoFile if git.IsErrNotExist(err) || models.IsErrRepoFileDoesNotExist(err) { @@ -650,6 +652,7 @@ func UploadFilePost(ctx *context.Context) { TreePath: form.TreePath, Message: message, Files: form.Files, + Signoff: form.Signoff, }); err != nil { if models.IsErrLFSFileLocked(err) { ctx.Data["Err_TreePath"] = true diff --git a/templates/repo/editor/commit_form.tmpl b/templates/repo/editor/commit_form.tmpl index 494a2113ee..cd417b427f 100644 --- a/templates/repo/editor/commit_form.tmpl +++ b/templates/repo/editor/commit_form.tmpl @@ -14,6 +14,12 @@
+
+
+ + +
+
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 86f09e2bbb..8c2b5948ea 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -12023,6 +12023,11 @@ "description": "new_branch (optional) will make a new branch from `branch` before creating the file", "type": "string", "x-go-name": "NewBranchName" + }, + "signoff": { + "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", + "type": "boolean", + "x-go-name": "Signoff" } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -12731,6 +12736,11 @@ "description": "sha is the SHA for the file that already exists", "type": "string", "x-go-name": "SHA" + }, + "signoff": { + "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", + "type": "boolean", + "x-go-name": "Signoff" } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -15762,6 +15772,11 @@ "description": "sha is the SHA for the file that already exists", "type": "string", "x-go-name": "SHA" + }, + "signoff": { + "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.", + "type": "boolean", + "x-go-name": "Signoff" } }, "x-go-package": "code.gitea.io/gitea/modules/structs"