Make label templates have consistent behavior and priority

modules/label/parser.go

@@ -36,21 +36,14 @@ func (err ErrTemplateLoad) Error() string {
 // GetTemplateFile loads the label template file by given name,
 // then parses and returns a list of name-color pairs and optionally description.
 func GetTemplateFile(name string) ([]*Label, error) {
-	data, err := options.Labels(name + ".yaml")
-	if err == nil && len(data) > 0 {
-		return parseYamlFormat(name+".yaml", data)
-	}
-
-	data, err = options.Labels(name + ".yml")
-	if err == nil && len(data) > 0 {
-		return parseYamlFormat(name+".yml", data)
-	}
-
-	data, err = options.Labels(name)
+	data, err := options.Labels(name)
 	if err != nil {
-		return nil, ErrTemplateLoad{name, fmt.Errorf("GetRepoInitFile: %w", err)}
+		return nil, ErrTemplateLoad{name, fmt.Errorf("GetTemplateFile: %w", err)}
 	}
 
+	if strings.HasSuffix(name, ".yaml") || strings.HasSuffix(name, ".yml") {
+		return parseYamlFormat(name, data)
+	}
 	return parseLegacyFormat(name, data)
 }
 

modules/repository/init.go

@@ -27,6 +27,12 @@ import (
 	asymkey_service "code.gitea.io/gitea/services/asymkey"
 )
 
+type OptionFile struct {
+	FileName    string
+	DisplayName string
+	Description string
+}
+
 var (
 	// Gitignores contains the gitiginore files
 	Gitignores []string
@@ -37,8 +43,8 @@ var (
 	// Readmes contains the readme files
 	Readmes []string
 
-	// LabelTemplates contains the label template files and the list of labels for each file
-	LabelTemplates map[string]string
+	// LabelTemplateFiles contains the label template files and the list of labels for each file
+	LabelTemplateFiles []OptionFile
 )
 
 // LoadRepoConfig loads the repository config
@@ -51,14 +57,6 @@ func LoadRepoConfig() {
 		if err != nil {
 			log.Fatal("Failed to get %s files: %v", t, err)
 		}
-		if t == "label" {
-			for i, f := range files {
-				ext := strings.ToLower(filepath.Ext(f))
-				if ext == ".yaml" || ext == ".yml" {
-					files[i] = f[:len(f)-len(ext)]
-				}
-			}
-		}
 		customPath := path.Join(setting.CustomPath, "options", t)
 		isDir, err := util.IsDir(customPath)
 		if err != nil {
@@ -71,7 +69,14 @@ func LoadRepoConfig() {
 			}
 
 			for _, f := range customFiles {
-				if !util.SliceContainsString(files, f, true) {
+				stat, err := os.Stat(filepath.Join(customPath, f))
+				if err != nil {
+					log.Fatal("Failed to stat custom %s files: %v", t, err)
+				}
+				if stat.Size() == 0 {
+					// it's good to give end users a chance to hide builtin options if they put an empty file in their custom directory
+					files = util.SliceRemoveAllFunc(files, func(s string) bool { return strings.EqualFold(s, f) })
+				} else if !util.SliceContainsString(files, f, true) {
 					files = append(files, f)
 				}
 			}
@@ -82,20 +87,23 @@ func LoadRepoConfig() {
 	Gitignores = typeFiles[0]
 	Licenses = typeFiles[1]
 	Readmes = typeFiles[2]
-	LabelTemplatesFiles := typeFiles[3]
+	labelTemplatesFiles := typeFiles[3]
 	sort.Strings(Gitignores)
 	sort.Strings(Licenses)
 	sort.Strings(Readmes)
-	sort.Strings(LabelTemplatesFiles)
+	sort.Strings(labelTemplatesFiles)
 
 	// Load label templates
-	LabelTemplates = make(map[string]string)
-	for _, templateFile := range LabelTemplatesFiles {
+	for _, templateFile := range labelTemplatesFiles {
 		labels, err := label.LoadFormatted(templateFile)
 		if err != nil {
 			log.Error("Failed to load labels: %v", err)
 		}
-		LabelTemplates[templateFile] = labels
+		LabelTemplateFiles = append(LabelTemplateFiles, OptionFile{
+			DisplayName: strings.TrimSuffix(templateFile, filepath.Ext(templateFile)),
+			FileName:    templateFile,
+			Description: labels,
+		})
 	}
 
 	// Filter out invalid names and promote preferred licenses.

routers/web/org/setting.go

@@ -247,6 +247,6 @@ func Labels(ctx *context.Context) {
 	ctx.Data["PageIsOrgSettings"] = true
 	ctx.Data["PageIsOrgSettingsLabels"] = true
 	ctx.Data["RequireTribute"] = true
-	ctx.Data["LabelTemplates"] = repo_module.LabelTemplates
+	ctx.Data["LabelTemplateFiles"] = repo_module.LabelTemplateFiles
 	ctx.HTML(http.StatusOK, tplSettingsLabels)
 }

routers/web/repo/issue_label.go

@@ -29,7 +29,7 @@ func Labels(ctx *context.Context) {
 	ctx.Data["PageIsIssueList"] = true
 	ctx.Data["PageIsLabels"] = true
 	ctx.Data["RequireTribute"] = true
-	ctx.Data["LabelTemplates"] = repo_module.LabelTemplates
+	ctx.Data["LabelTemplateFiles"] = repo_module.LabelTemplateFiles
 	ctx.HTML(http.StatusOK, tplLabels)
 }
 

routers/web/repo/repo.go

@@ -132,7 +132,7 @@ func Create(ctx *context.Context) {
 
 	// Give default value for template to render.
 	ctx.Data["Gitignores"] = repo_module.Gitignores
-	ctx.Data["LabelTemplates"] = repo_module.LabelTemplates
+	ctx.Data["LabelTemplateFiles"] = repo_module.LabelTemplateFiles
 	ctx.Data["Licenses"] = repo_module.Licenses
 	ctx.Data["Readmes"] = repo_module.Readmes
 	ctx.Data["readme"] = "Default"
@@ -200,7 +200,7 @@ func CreatePost(ctx *context.Context) {
 	ctx.Data["Title"] = ctx.Tr("new_repo")
 
 	ctx.Data["Gitignores"] = repo_module.Gitignores
-	ctx.Data["LabelTemplates"] = repo_module.LabelTemplates
+	ctx.Data["LabelTemplateFiles"] = repo_module.LabelTemplateFiles
 	ctx.Data["Licenses"] = repo_module.Licenses
 	ctx.Data["Readmes"] = repo_module.Readmes
 

templates/repo/create.tmpl

@@ -117,8 +117,8 @@
 								<div class="default text">{{.locale.Tr "repo.issue_labels_helper"}}</div>
 								<div class="menu">
 									<div class="item" data-value="">{{.locale.Tr "repo.issue_labels_helper"}}</div>
-									{{range $template, $labels := .LabelTemplates}}
-										<div class="item" data-value="{{$template}}">{{$template}}<br><i>({{$labels}})</i></div>
+									{{range .LabelTemplateFiles}}
+										<div class="item" data-value="{{.FileName}}">{{.DisplayName}}<br><i>({{.Description}})</i></div>
 									{{end}}
 								</div>
 							</div>

templates/repo/issue/labels/label_load_template.tmpl

@@ -10,8 +10,8 @@
 						<input type="hidden" name="template_name" value="Default">
 						<div class="default text">{{.locale.Tr "repo.issues.label_templates.helper"}}</div>
 						<div class="menu">
-							{{range $template, $labels := .LabelTemplates}}
-								<div class="item" data-value="{{$template}}">{{$template}}<br><i>({{$labels}})</i></div>
+							{{range .LabelTemplateFiles}}
+								<div class="item" data-value="{{.FileName}}">{{.DisplayName}}<br><i>({{.Description}})</i></div>
 							{{end}}
 						</div>
 						{{svg "octicon-triangle-down" 18 "dropdown icon"}}