mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-05-22 20:22:42 +00:00
386e7f8208
Send a Mail when an action run fails or a workflow recovers. This PR depends on https://codeberg.org/forgejo/forgejo/pulls/7491 closes #3719 ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/7509): <!--number 7509 --><!--line 0 --><!--description c2VuZCBtYWlsIG9uIGZhaWxlZCBvciByZWNvdmVyZWQgd29ya2Zsb3cgcnVu-->send mail on failed or recovered workflow run<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7509 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: christopher-besch <mail@chris-besch.com> Co-committed-by: christopher-besch <mail@chris-besch.com>
84 lines
2.4 KiB
Go
84 lines
2.4 KiB
Go
// Copyright 2025 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
package mailer
|
|
|
|
import (
|
|
"bytes"
|
|
|
|
actions_model "forgejo.org/models/actions"
|
|
user_model "forgejo.org/models/user"
|
|
"forgejo.org/modules/base"
|
|
"forgejo.org/modules/setting"
|
|
"forgejo.org/modules/translation"
|
|
)
|
|
|
|
const (
|
|
tplActionNowDone base.TplName = "actions/now_done"
|
|
)
|
|
|
|
// requires !run.Status.IsSuccess() or !lastRun.Status.IsSuccess()
|
|
func MailActionRun(run *actions_model.ActionRun, priorStatus actions_model.Status, lastRun *actions_model.ActionRun) error {
|
|
if setting.MailService == nil {
|
|
// No mail service configured
|
|
return nil
|
|
}
|
|
|
|
if run.TriggerUser.Email != "" && run.TriggerUser.EmailNotificationsPreference != user_model.EmailNotificationsDisabled {
|
|
if err := sendMailActionRun(run.TriggerUser, run, priorStatus, lastRun); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if run.Repo.Owner.Email != "" && run.Repo.Owner.Email != run.TriggerUser.Email && run.Repo.Owner.EmailNotificationsPreference != user_model.EmailNotificationsDisabled {
|
|
if err := sendMailActionRun(run.Repo.Owner, run, priorStatus, lastRun); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func sendMailActionRun(to *user_model.User, run *actions_model.ActionRun, priorStatus actions_model.Status, lastRun *actions_model.ActionRun) error {
|
|
var (
|
|
locale = translation.NewLocale(to.Language)
|
|
content bytes.Buffer
|
|
)
|
|
|
|
var subject string
|
|
if run.Status.IsSuccess() {
|
|
subject = locale.TrString("mail.actions.successful_run_after_failure_subject", run.Title, run.Repo.FullName())
|
|
} else {
|
|
subject = locale.TrString("mail.actions.not_successful_run", run.Title, run.Repo.FullName())
|
|
}
|
|
|
|
commitSHA := run.CommitSHA
|
|
if len(commitSHA) > 7 {
|
|
commitSHA = commitSHA[:7]
|
|
}
|
|
branch := run.PrettyRef()
|
|
|
|
data := map[string]any{
|
|
"locale": locale,
|
|
"Link": run.HTMLURL(),
|
|
"Subject": subject,
|
|
"Language": locale.Language(),
|
|
"RepoFullName": run.Repo.FullName(),
|
|
"Run": run,
|
|
"TriggerUserLink": run.TriggerUser.HTMLURL(),
|
|
"LastRun": lastRun,
|
|
"PriorStatus": priorStatus,
|
|
"CommitSHA": commitSHA,
|
|
"Branch": branch,
|
|
"IsSuccess": run.Status.IsSuccess(),
|
|
}
|
|
|
|
if err := bodyTemplates.ExecuteTemplate(&content, string(tplActionNowDone), data); err != nil {
|
|
return err
|
|
}
|
|
|
|
msg := NewMessage(to.EmailTo(), subject, content.String())
|
|
msg.Info = subject
|
|
SendAsync(msg)
|
|
|
|
return nil
|
|
}
|