1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-06-27 16:35:57 +00:00
forgejo/services/mailer/mail_actions.go
Earl Warren b2c4fc9f94 bug: Forgejo Actions email notifications are opt-in (#8242)
* Add the `notify-email` column / NotifyEmail to ActionRun and set it:
  * services/actions/workflows.go `Dispatch`
  * services/actions/schedule_tasks.go `CreateScheduleTask`
  * services/actions/notifier_helper.go `handleWorkflows`
* Only send an email if the workflow has `enable-email-notifications: true` by having `MailActionRun` return immediately if `NotifyEmail` is false.
* Ignore or silently fail on `enable-email-notifications: true` parsing errors. Reporting such errors  belongs in workflow validation, not when it is evaluated for the notifications.
* Add unit and integration tests.

Refs: https://codeberg.org/forgejo/forgejo/issues/8187

## 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.
  - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.

### Documentation

- [x] I did not document these changes and I do not expect someone else to do it.

### Release notes

- [x] I do not want this change to show in the release notes.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8242
Reviewed-by: Christopher Besch <mail@chris-besch.com>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2025-06-21 13:11:01 +02:00

89 lines
2.3 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.NotifyEmail {
return nil
}
user := run.TriggerUser
// this happens e.g. when this is a scheduled run
if user.IsSystem() {
user = run.Repo.Owner
}
if user.IsSystem() || user.Email == "" {
return nil
}
if user.EmailNotificationsPreference == user_model.EmailNotificationsDisabled {
return nil
}
return sendMailActionRun(user, run, priorStatus, lastRun)
}
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
}