feat: automatic generation of release notes

dummy commit

fix cs

fix

fix

remove test file

Author: dawidgora

options/locale/locale_en-US.ini

@@ -2751,6 +2751,14 @@ release.add_tag_msg = Use the title and content of release as tag message.
 release.add_tag = Create Tag Only
 release.releases_for = Releases for %s
 release.tags_for = Tags for %s
+release.generate_notes = Generate release notes
+release.generate_notes_desc = Automatically add merged pull requests and a changelog link for this release.
+release.previous_tag = Previous tag
+release.previous_tag_auto = Auto
+release.generate_notes_tag_not_found = Tag "%s" does not exist in this repository.
+release.generate_notes_no_base_tag = No previous tag found to generate release notes.
+release.generate_notes_target_not_found = The release target "%s" cannot be found.
+release.generate_notes_missing_tag = Enter a tag name to generate release notes.
 
 branch.name = Branch Name
 branch.already_exists = A branch named "%s" already exists.

routers/web/repo/release.go

@@ -18,6 +18,7 @@ import (
 	"code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/markup/markdown"
 	"code.gitea.io/gitea/modules/optional"
 	"code.gitea.io/gitea/modules/setting"
@@ -390,6 +391,45 @@ func NewRelease(ctx *context.Context) {
 	ctx.HTML(http.StatusOK, tplReleaseNew)
 }
 
+// GenerateReleaseNotes builds release notes content for the given tag and base.
+func GenerateReleaseNotes(ctx *context.Context) {
+	form := web.GetForm(ctx).(*forms.GenerateReleaseNotesForm)
+
+	if ctx.HasError() {
+		ctx.JSONError(ctx.GetErrMsg())
+		return
+	}
+
+	result, err := release_service.GenerateReleaseNotes(ctx, ctx.Repo.Repository, ctx.Repo.GitRepo, release_service.GenerateReleaseNotesOptions{
+		TagName:     form.TagName,
+		Target:      form.Target,
+		PreviousTag: form.PreviousTag,
+	})
+	if err != nil {
+		var tagErr release_service.ErrReleaseNotesTagNotFound
+		var targetErr release_service.ErrReleaseNotesTargetNotFound
+		switch {
+		case release_service.IsErrReleaseNotesNoBaseTag(err):
+			ctx.JSONError(ctx.Tr("repo.release.generate_notes_no_base_tag"))
+		case errors.As(err, &tagErr):
+			ctx.JSONError(ctx.Tr("repo.release.generate_notes_tag_not_found", tagErr.TagName))
+		case errors.As(err, &targetErr):
+			ctx.JSONError(ctx.Tr("repo.release.generate_notes_target_not_found", targetErr.Ref))
+		default:
+			log.Error("GenerateReleaseNotes: %v", err)
+			ctx.JSON(http.StatusInternalServerError, map[string]any{
+				"errorMessage": ctx.Tr("error.occurred"),
+			})
+		}
+		return
+	}
+
+	ctx.JSON(http.StatusOK, map[string]any{
+		"content":      result.Content,
+		"previous_tag": result.PreviousTag,
+	})
+}
+
 // NewReleasePost response for creating a release
 func NewReleasePost(ctx *context.Context) {
 	newReleaseCommon(ctx)

routers/web/web.go

@@ -1406,6 +1406,7 @@ func registerWebRoutes(m *web.Router) {
 		m.Group("/releases", func() {
 			m.Get("/new", repo.NewRelease)
 			m.Post("/new", web.Bind(forms.NewReleaseForm{}), repo.NewReleasePost)
+			m.Post("/generate-notes", web.Bind(forms.GenerateReleaseNotesForm{}), repo.GenerateReleaseNotes)
 			m.Post("/delete", repo.DeleteRelease)
 			m.Post("/attachments", repo.UploadReleaseAttachment)
 			m.Post("/attachments/remove", repo.DeleteAttachment)

services/forms/repo_form.go

@@ -638,6 +638,19 @@ func (f *NewReleaseForm) Validate(req *http.Request, errs binding.Errors) bindin
 	return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
 }
 
+// GenerateReleaseNotesForm retrieves release notes recommendations.
+type GenerateReleaseNotesForm struct {
+	TagName     string `form:"tag_name" binding:"Required;GitRefName;MaxSize(255)"`
+	Target      string `form:"tag_target" binding:"MaxSize(255)"`
+	PreviousTag string `form:"previous_tag" binding:"MaxSize(255)"`
+}
+
+// Validate validates the fields
+func (f *GenerateReleaseNotesForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
+	ctx := context.GetValidateContext(req)
+	return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
+}
+
 // EditReleaseForm form for changing release
 type EditReleaseForm struct {
 	Title      string `form:"title" binding:"Required;MaxSize(255)"`