Send email on Workflow Run Success/Failure (#34982)

Closes #23725 

![1](https://github.com/user-attachments/assets/9bfa76ea-8c45-4155-a5d4-dc2f0667faa8)

![2](https://github.com/user-attachments/assets/49be7402-e5d5-486e-a1c2-8d3222540b13)

/claim #23725

---------

Signed-off-by: NorthRealm <[email protected]>
Co-authored-by: wxiaoguang <[email protected]>
Co-authored-by: ChristopherHX <[email protected]>

Author: 3 people

models/user/setting_keys.go renamed to models/user/setting_options.go

@@ -21,4 +21,9 @@ const (
 	SignupUserAgent = "signup.user_agent"
 
 	SettingsKeyCodeViewShowFileTree = "code_view.show_file_tree"
+
+	SettingsKeyEmailNotificationGiteaActions        = "email_notification.gitea_actions"
+	SettingEmailNotificationGiteaActionsAll         = "all"
+	SettingEmailNotificationGiteaActionsFailureOnly = "failure-only" // Default for actions email preference
+	SettingEmailNotificationGiteaActionsDisabled    = "disabled"
 )

options/locale/locale_en-US.ini

@@ -1021,6 +1021,8 @@ email_notifications.onmention = Only Email on Mention
 email_notifications.disable = Disable Email Notifications
 email_notifications.submit = Set Email Preference
 email_notifications.andyourown = And Your Own Notifications
+email_notifications.actions.desc = Notifications for workflow runs on repositories set up with <a target="_blank" href="%s">Gitea Actions</a>.
+email_notifications.actions.failure_only = Only notify for failed workflow runs
 
 visibility = User visibility
 visibility.public = Public

routers/web/devtest/mail_preview.go

@@ -16,7 +16,7 @@ import (
 
 func MailPreviewRender(ctx *context.Context) {
 	tmplName := ctx.PathParam("*")
-	mockDataContent, err := templates.AssetFS().ReadFile("mail/" + tmplName + ".mock.yml")
+	mockDataContent, err := templates.AssetFS().ReadFile("mail/" + tmplName + ".devtest.yml")
 	mockData := map[string]any{}
 	if err == nil {
 		err = yaml.Unmarshal(mockDataContent, &mockData)

routers/web/user/setting/notifications.go

@@ -4,11 +4,10 @@
 package setting
 
 import (
-	"errors"
 	"net/http"
 
+	"code.gitea.io/gitea/models/unit"
 	user_model "code.gitea.io/gitea/models/user"
-	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/optional"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/templates"
@@ -29,6 +28,13 @@ func Notifications(ctx *context.Context) {
 	ctx.Data["PageIsSettingsNotifications"] = true
 	ctx.Data["EmailNotificationsPreference"] = ctx.Doer.EmailNotificationsPreference
 
+	actionsEmailPref, err := user_model.GetUserSetting(ctx, ctx.Doer.ID, user_model.SettingsKeyEmailNotificationGiteaActions, user_model.SettingEmailNotificationGiteaActionsFailureOnly)
+	if err != nil {
+		ctx.ServerError("GetUserSetting", err)
+		return
+	}
+	ctx.Data["ActionsEmailNotificationsPreference"] = actionsEmailPref
+
 	ctx.HTML(http.StatusOK, tplSettingsNotifications)
 }
 
@@ -44,19 +50,40 @@ func NotificationsEmailPost(ctx *context.Context) {
 		preference == user_model.EmailNotificationsOnMention ||
 		preference == user_model.EmailNotificationsDisabled ||
 		preference == user_model.EmailNotificationsAndYourOwn) {
-		log.Error("Email notifications preference change returned unrecognized option %s: %s", preference, ctx.Doer.Name)
-		ctx.ServerError("SetEmailPreference", errors.New("option unrecognized"))
+		ctx.Flash.Error(ctx.Tr("invalid_data", preference))
+		ctx.Redirect(setting.AppSubURL + "/user/settings/notifications")
 		return
 	}
 	opts := &user.UpdateOptions{
 		EmailNotificationsPreference: optional.Some(preference),
 	}
 	if err := user.UpdateUser(ctx, ctx.Doer, opts); err != nil {
-		log.Error("Set Email Notifications failed: %v", err)
 		ctx.ServerError("UpdateUser", err)
 		return
 	}
-	log.Trace("Email notifications preference made %s: %s", preference, ctx.Doer.Name)
+	ctx.Flash.Success(ctx.Tr("settings.email_preference_set_success"))
+	ctx.Redirect(setting.AppSubURL + "/user/settings/notifications")
+}
+
+// NotificationsActionsEmailPost set user's email notification preference on Gitea Actions
+func NotificationsActionsEmailPost(ctx *context.Context) {
+	if !setting.Actions.Enabled || unit.TypeActions.UnitGlobalDisabled() {
+		ctx.NotFound(nil)
+		return
+	}
+
+	preference := ctx.FormString("preference")
+	if !(preference == user_model.SettingEmailNotificationGiteaActionsAll ||
+		preference == user_model.SettingEmailNotificationGiteaActionsDisabled ||
+		preference == user_model.SettingEmailNotificationGiteaActionsFailureOnly) {
+		ctx.Flash.Error(ctx.Tr("invalid_data", preference))
+		ctx.Redirect(setting.AppSubURL + "/user/settings/notifications")
+		return
+	}
+	if err := user_model.SetUserSetting(ctx, ctx.Doer.ID, user_model.SettingsKeyEmailNotificationGiteaActions, preference); err != nil {
+		ctx.ServerError("SetUserSetting", err)
+		return
+	}
 	ctx.Flash.Success(ctx.Tr("settings.email_preference_set_success"))
 	ctx.Redirect(setting.AppSubURL + "/user/settings/notifications")
 }

routers/web/web.go

@@ -598,6 +598,7 @@ func registerWebRoutes(m *web.Router) {
 		m.Group("/notifications", func() {
 			m.Get("", user_setting.Notifications)
 			m.Post("/email", user_setting.NotificationsEmailPost)
+			m.Post("/actions", user_setting.NotificationsActionsEmailPost)
 		})
 		m.Group("/security", func() {
 			m.Get("", security.Security)

services/mailer/mail.go

@@ -174,3 +174,41 @@ func fromDisplayName(u *user_model.User) string {
 	}
 	return u.GetCompleteName()
 }
+
+func generateMetadataHeaders(repo *repo_model.Repository) map[string]string {
+	return map[string]string{
+		// https://datatracker.ietf.org/doc/html/rfc2919
+		"List-ID": fmt.Sprintf("%s <%s.%s.%s>", repo.FullName(), repo.Name, repo.OwnerName, setting.Domain),
+
+		// https://datatracker.ietf.org/doc/html/rfc2369
+		"List-Archive": fmt.Sprintf("<%s>", repo.HTMLURL()),
+
+		"X-Mailer": "Gitea",
+
+		"X-Gitea-Repository":      repo.Name,
+		"X-Gitea-Repository-Path": repo.FullName(),
+		"X-Gitea-Repository-Link": repo.HTMLURL(),
+
+		"X-GitLab-Project":      repo.Name,
+		"X-GitLab-Project-Path": repo.FullName(),
+	}
+}
+
+func generateSenderRecipientHeaders(doer, recipient *user_model.User) map[string]string {
+	return map[string]string{
+		"X-Gitea-Sender":             doer.Name,
+		"X-Gitea-Recipient":          recipient.Name,
+		"X-Gitea-Recipient-Address":  recipient.Email,
+		"X-GitHub-Sender":            doer.Name,
+		"X-GitHub-Recipient":         recipient.Name,
+		"X-GitHub-Recipient-Address": recipient.Email,
+	}
+}
+
+func generateReasonHeaders(reason string) map[string]string {
+	return map[string]string{
+		"X-Gitea-Reason":              reason,
+		"X-GitHub-Reason":             reason,
+		"X-GitLab-NotificationReason": reason,
+	}
+}

services/mailer/mail_issue_common.go

@@ -7,6 +7,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"maps"
 	"strconv"
 	"strings"
 	"time"
@@ -29,7 +30,7 @@ import (
 // Many e-mail service providers have limitations on the size of the email body, it's usually from 10MB to 25MB
 const maxEmailBodySize = 9_000_000
 
-func fallbackMailSubject(issue *issues_model.Issue) string {
+func fallbackIssueMailSubject(issue *issues_model.Issue) string {
 	return fmt.Sprintf("[%s] %s (#%d)", issue.Repo.FullName(), issue.Title, issue.Index)
 }
 
@@ -86,7 +87,7 @@ func composeIssueCommentMessages(ctx context.Context, comment *mailComment, lang
 	if actName != "new" {
 		prefix = "Re: "
 	}
-	fallback = prefix + fallbackMailSubject(comment.Issue)
+	fallback = prefix + fallbackIssueMailSubject(comment.Issue)
 
 	if comment.Comment != nil && comment.Comment.Review != nil {
 		reviewComments = make([]*issues_model.Comment, 0, 10)
@@ -202,7 +203,7 @@ func composeIssueCommentMessages(ctx context.Context, comment *mailComment, lang
 		msg.SetHeader("References", references...)
 		msg.SetHeader("List-Unsubscribe", listUnsubscribe...)
 
-		for key, value := range generateAdditionalHeaders(comment, actType, recipient) {
+		for key, value := range generateAdditionalHeadersForIssue(comment, actType, recipient) {
 			msg.SetHeader(key, value)
 		}
 
@@ -302,35 +303,18 @@ func generateMessageIDForIssue(issue *issues_model.Issue, comment *issues_model.
 	return fmt.Sprintf("<%s/%s/%d%s@%s>", issue.Repo.FullName(), path, issue.Index, extra, setting.Domain)
 }
 
-func generateAdditionalHeaders(ctx *mailComment, reason string, recipient *user_model.User) map[string]string {
+func generateAdditionalHeadersForIssue(ctx *mailComment, reason string, recipient *user_model.User) map[string]string {
 	repo := ctx.Issue.Repo
 
-	return map[string]string{
-		// https://datatracker.ietf.org/doc/html/rfc2919
-		"List-ID": fmt.Sprintf("%s <%s.%s.%s>", repo.FullName(), repo.Name, repo.OwnerName, setting.Domain),
-
-		// https://datatracker.ietf.org/doc/html/rfc2369
-		"List-Archive": fmt.Sprintf("<%s>", repo.HTMLURL()),
-
-		"X-Mailer":                  "Gitea",
-		"X-Gitea-Reason":            reason,
-		"X-Gitea-Sender":            ctx.Doer.Name,
-		"X-Gitea-Recipient":         recipient.Name,
-		"X-Gitea-Recipient-Address": recipient.Email,
-		"X-Gitea-Repository":        repo.Name,
-		"X-Gitea-Repository-Path":   repo.FullName(),
-		"X-Gitea-Repository-Link":   repo.HTMLURL(),
-		"X-Gitea-Issue-ID":          strconv.FormatInt(ctx.Issue.Index, 10),
-		"X-Gitea-Issue-Link":        ctx.Issue.HTMLURL(),
-
-		"X-GitHub-Reason":            reason,
-		"X-GitHub-Sender":            ctx.Doer.Name,
-		"X-GitHub-Recipient":         recipient.Name,
-		"X-GitHub-Recipient-Address": recipient.Email,
-
-		"X-GitLab-NotificationReason": reason,
-		"X-GitLab-Project":            repo.Name,
-		"X-GitLab-Project-Path":       repo.FullName(),
-		"X-GitLab-Issue-IID":          strconv.FormatInt(ctx.Issue.Index, 10),
-	}
+	issueID := strconv.FormatInt(ctx.Issue.Index, 10)
+	headers := generateMetadataHeaders(repo)
+
+	maps.Copy(headers, generateSenderRecipientHeaders(ctx.Doer, recipient))
+	maps.Copy(headers, generateReasonHeaders(reason))
+
+	headers["X-Gitea-Issue-ID"] = issueID
+	headers["X-Gitea-Issue-Link"] = ctx.Issue.HTMLURL()
+	headers["X-GitLab-Issue-IID"] = issueID
+
+	return headers
 }

services/mailer/mail_test.go

@@ -16,6 +16,7 @@ import (
 	"testing"
 	texttmpl "text/template"
 
+	actions_model "code.gitea.io/gitea/models/actions"
 	activities_model "code.gitea.io/gitea/models/activities"
 	"code.gitea.io/gitea/models/db"
 	issues_model "code.gitea.io/gitea/models/issues"
@@ -298,13 +299,13 @@ func testComposeIssueCommentMessage(t *testing.T, ctx *mailComment, recipients [
 	return msgs[0]
 }
 
-func TestGenerateAdditionalHeaders(t *testing.T) {
+func TestGenerateAdditionalHeadersForIssue(t *testing.T) {
 	doer, _, issue, _ := prepareMailerTest(t)
 
 	comment := &mailComment{Issue: issue, Doer: doer}
 	recipient := &user_model.User{Name: "test", Email: "[email protected]"}
 
-	headers := generateAdditionalHeaders(comment, "dummy-reason", recipient)
+	headers := generateAdditionalHeadersForIssue(comment, "dummy-reason", recipient)
 
 	expected := map[string]string{
 		"List-ID":                   "user2/repo1 <repo1.user2.localhost>",
@@ -441,6 +442,16 @@ func TestGenerateMessageIDForRelease(t *testing.T) {
 	assert.Equal(t, "<owner/repo/releases/1@localhost>", msgID)
 }
 
+func TestGenerateMessageIDForActionsWorkflowRunStatusEmail(t *testing.T) {
+	assert.NoError(t, unittest.PrepareTestDatabase())
+
+	repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2})
+	run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: 795, RepoID: repo.ID})
+	assert.NoError(t, run.LoadAttributes(db.DefaultContext))
+	msgID := generateMessageIDForActionsWorkflowRunStatusEmail(repo, run)
+	assert.Equal(t, "<user2/repo2/actions/runs/191@localhost>", msgID)
+}
+
 func TestFromDisplayName(t *testing.T) {
 	tmpl, err := texttmpl.New("mailFrom").Parse("{{ .DisplayName }}")
 	assert.NoError(t, err)