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 <155140859+NorthRealm@users.noreply.github.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: ChristopherHX <christopher.homberger@web.de>
2025-07-26 12:18:36 +00:00 · 2025-07-16 09:54:31 +08:00
parent cd3fb95d4c
commit 0d00ec7eed
14 changed files with 361 additions and 38 deletions
--- a/services/mailer/mail_workflow_run.go
+++ b/services/mailer/mail_workflow_run.go
@@ -0,0 +1,165 @@
+// Copyright 2025 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package mailer
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"sort"
+
+	actions_model "code.gitea.io/gitea/models/actions"
+	repo_model "code.gitea.io/gitea/models/repo"
+	user_model "code.gitea.io/gitea/models/user"
+	"code.gitea.io/gitea/modules/base"
+	"code.gitea.io/gitea/modules/log"
+	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/translation"
+	"code.gitea.io/gitea/services/convert"
+	sender_service "code.gitea.io/gitea/services/mailer/sender"
+)
+
+const tplWorkflowRun = "notify/workflow_run"
+
+type convertedWorkflowJob struct {
+	HTMLURL string
+	Status  actions_model.Status
+	Name    string
+	Attempt int64
+}
+
+func generateMessageIDForActionsWorkflowRunStatusEmail(repo *repo_model.Repository, run *actions_model.ActionRun) string {
+	return fmt.Sprintf("<%s/actions/runs/%d@%s>", repo.FullName(), run.Index, setting.Domain)
+}
+
+func composeAndSendActionsWorkflowRunStatusEmail(ctx context.Context, repo *repo_model.Repository, run *actions_model.ActionRun, sender *user_model.User, recipients []*user_model.User) {
+	subject := "Run"
+	switch run.Status {
+	case actions_model.StatusFailure:
+		subject += " failed"
+	case actions_model.StatusCancelled:
+		subject += " cancelled"
+	case actions_model.StatusSuccess:
+		subject += " succeeded"
+	}
+	subject = fmt.Sprintf("%s: %s (%s)", subject, run.WorkflowID, base.ShortSha(run.CommitSHA))
+	displayName := fromDisplayName(sender)
+	messageID := generateMessageIDForActionsWorkflowRunStatusEmail(repo, run)
+	metadataHeaders := generateMetadataHeaders(repo)
+
+	jobs, err := actions_model.GetRunJobsByRunID(ctx, run.ID)
+	if err != nil {
+		log.Error("GetRunJobsByRunID: %v", err)
+		return
+	}
+	sort.SliceStable(jobs, func(i, j int) bool {
+		si, sj := jobs[i].Status, jobs[j].Status
+		/*
+			If both i and j are/are not success, leave it to si < sj.
+			If i is success and j is not, since the desired is j goes "smaller" and i goes "bigger", this func should return false.
+			If j is success and i is not, since the desired is i goes "smaller" and j goes "bigger", this func should return true.
+		*/
+		if si.IsSuccess() != sj.IsSuccess() {
+			return !si.IsSuccess()
+		}
+		return si < sj
+	})
+
+	convertedJobs := make([]convertedWorkflowJob, 0, len(jobs))
+	for _, job := range jobs {
+		converted0, err := convert.ToActionWorkflowJob(ctx, repo, nil, job)
+		if err != nil {
+			log.Error("convert.ToActionWorkflowJob: %v", err)
+			continue
+		}
+		convertedJobs = append(convertedJobs, convertedWorkflowJob{
+			HTMLURL: converted0.HTMLURL,
+			Name:    converted0.Name,
+			Status:  job.Status,
+			Attempt: converted0.RunAttempt,
+		})
+	}
+
+	langMap := make(map[string][]*user_model.User)
+	for _, user := range recipients {
+		langMap[user.Language] = append(langMap[user.Language], user)
+	}
+	for lang, tos := range langMap {
+		locale := translation.NewLocale(lang)
+		var runStatusText string
+		switch run.Status {
+		case actions_model.StatusSuccess:
+			runStatusText = "All jobs have succeeded"
+		case actions_model.StatusFailure:
+			runStatusText = "All jobs have failed"
+			for _, job := range jobs {
+				if !job.Status.IsFailure() {
+					runStatusText = "Some jobs were not successful"
+					break
+				}
+			}
+		case actions_model.StatusCancelled:
+			runStatusText = "All jobs have been cancelled"
+		}
+		var mailBody bytes.Buffer
+		if err := LoadedTemplates().BodyTemplates.ExecuteTemplate(&mailBody, tplWorkflowRun, map[string]any{
+			"Subject":       subject,
+			"Repo":          repo,
+			"Run":           run,
+			"RunStatusText": runStatusText,
+			"Jobs":          convertedJobs,
+			"locale":        locale,
+		}); err != nil {
+			log.Error("ExecuteTemplate [%s]: %v", tplWorkflowRun, err)
+			return
+		}
+		msgs := make([]*sender_service.Message, 0, len(tos))
+		for _, rec := range tos {
+			msg := sender_service.NewMessageFrom(
+				rec.Email,
+				displayName,
+				setting.MailService.FromEmail,
+				subject,
+				mailBody.String(),
+			)
+			msg.Info = subject
+			for k, v := range generateSenderRecipientHeaders(sender, rec) {
+				msg.SetHeader(k, v)
+			}
+			for k, v := range metadataHeaders {
+				msg.SetHeader(k, v)
+			}
+			msg.SetHeader("Message-ID", messageID)
+			msgs = append(msgs, msg)
+		}
+		SendAsync(msgs...)
+	}
+}
+
+func MailActionsTrigger(ctx context.Context, sender *user_model.User, repo *repo_model.Repository, run *actions_model.ActionRun) {
+	if setting.MailService == nil {
+		return
+	}
+	if run.Status.IsSkipped() {
+		return
+	}
+
+	recipients := make([]*user_model.User, 0)
+
+	if !sender.IsGiteaActions() && !sender.IsGhost() && sender.IsMailable() {
+		notifyPref, err := user_model.GetUserSetting(ctx, sender.ID,
+			user_model.SettingsKeyEmailNotificationGiteaActions, user_model.SettingEmailNotificationGiteaActionsFailureOnly)
+		if err != nil {
+			log.Error("GetUserSetting: %v", err)
+			return
+		}
+		if notifyPref == user_model.SettingEmailNotificationGiteaActionsAll || !run.Status.IsSuccess() && notifyPref != user_model.SettingEmailNotificationGiteaActionsDisabled {
+			recipients = append(recipients, sender)
+		}
+	}
+
+	if len(recipients) > 0 {
+		composeAndSendActionsWorkflowRunStatusEmail(ctx, repo, run, sender, recipients)
+	}
+}