From 658bfc2704eb7630911b5a3c994258757dd79cec Mon Sep 17 00:00:00 2001 From: Andrey Nering Date: Wed, 17 Feb 2016 20:21:31 -0200 Subject: [PATCH] Implement issue and pull request templates. Similar to GitHub: https://github.com/blog/2111-issue-and-pull-request-templates Priority: - root - .gogs - .github --- routers/repo/issue.go | 48 +++++++++++++++++++++++++++ routers/repo/pull.go | 11 ++++++ templates/repo/issue/comment_tab.tmpl | 2 +- 3 files changed, 60 insertions(+), 1 deletion(-) diff --git a/routers/repo/issue.go b/routers/repo/issue.go index 635dee930e..3120a8ba27 100644 --- a/routers/repo/issue.go +++ b/routers/repo/issue.go @@ -7,6 +7,8 @@ package repo import ( "errors" "fmt" + "io" + "io/ioutil" "net/http" "net/url" "strings" @@ -34,11 +36,19 @@ const ( MILESTONE base.TplName = "repo/issue/milestones" MILESTONE_NEW base.TplName = "repo/issue/milestone_new" MILESTONE_EDIT base.TplName = "repo/issue/milestone_edit" + + ISSUE_TEMPLATE_KEY = "IssueTemplate" ) var ( ErrFileTypeForbidden = errors.New("File type is not allowed") ErrTooManyFiles = errors.New("Maximum number of files to upload exceeded") + + IssueTemplateCandidates = []string{ + "ISSUE_TEMPLATE.md", + ".gogs/ISSUE_TEMPLATE.md", + ".github/ISSUE_TEMPLATE.md", + } ) func MustEnableIssues(ctx *middleware.Context) { @@ -281,9 +291,47 @@ func RetrieveRepoMetas(ctx *middleware.Context, repo *models.Repository) []*mode return labels } +func getFileContentFromDefaultBranch(ctx *middleware.Context, filename string) (string, bool) { + var r io.Reader + var bytes []byte + + if ctx.Repo.Commit == nil { + var err error + ctx.Repo.Commit, err = ctx.Repo.GitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultBranch) + if err != nil { + return "", false + } + } + + entry, err := ctx.Repo.Commit.GetTreeEntryByPath(filename) + if err != nil { + return "", false + } + r, err = entry.Blob().Data() + if err != nil { + return "", false + } + bytes, err = ioutil.ReadAll(r) + if err != nil { + return "", false + } + return string(bytes), true +} + +func setTemplateIfExists(ctx *middleware.Context, ctxDataKey string, possibleFiles []string) { + for _, filename := range possibleFiles { + content, found := getFileContentFromDefaultBranch(ctx, filename) + if found { + ctx.Data[ctxDataKey] = content + return + } + } +} + func NewIssue(ctx *middleware.Context) { ctx.Data["Title"] = ctx.Tr("repo.issues.new") ctx.Data["PageIsIssueList"] = true + setTemplateIfExists(ctx, ISSUE_TEMPLATE_KEY, IssueTemplateCandidates) renderAttachmentSettings(ctx) RetrieveRepoMetas(ctx, ctx.Repo.Repository) diff --git a/routers/repo/pull.go b/routers/repo/pull.go index 3240461c84..cf8c4829b4 100644 --- a/routers/repo/pull.go +++ b/routers/repo/pull.go @@ -26,6 +26,16 @@ const ( COMPARE_PULL base.TplName = "repo/pulls/compare" PULL_COMMITS base.TplName = "repo/pulls/commits" PULL_FILES base.TplName = "repo/pulls/files" + + PULL_REQUEST_TEMPLATE_KEY = "PullRequestTemplate" +) + +var ( + PullRequestTemplateCandidates = []string{ + "PULL_REQUEST.md", + ".gogs/PULL_REQUEST.md", + ".github/PULL_REQUEST.md", + } ) func getForkRepository(ctx *middleware.Context) *models.Repository { @@ -540,6 +550,7 @@ func CompareAndPullRequest(ctx *middleware.Context) { ctx.Data["PageIsComparePull"] = true ctx.Data["IsDiffCompare"] = true ctx.Data["RequireHighlightJS"] = true + setTemplateIfExists(ctx, PULL_REQUEST_TEMPLATE_KEY, PullRequestTemplateCandidates) renderAttachmentSettings(ctx) headUser, headRepo, headGitRepo, prInfo, baseBranch, headBranch := ParseCompareInfo(ctx) diff --git a/templates/repo/issue/comment_tab.tmpl b/templates/repo/issue/comment_tab.tmpl index 8f6c8ca778..851c3b1fae 100644 --- a/templates/repo/issue/comment_tab.tmpl +++ b/templates/repo/issue/comment_tab.tmpl @@ -4,7 +4,7 @@ {{.i18n.Tr "repo.release.preview"}}
- +
{{.i18n.Tr "repo.release.loading"}}