notify

package

v0.1.5 Latest Latest Go to latest Published: Jun 27, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jclement/pullpilot

Links

Open Source Insights

Documentation ¶

Overview ¶

Package notify sends human-facing notifications via shoutrrr. With no URL configured it is a no-op (events still appear in the logs). Sends are fire-and-forget so a slow notification endpoint never blocks an update cycle.

Index ¶

type Notifier
- func New(url string, log zerolog.Logger) *Notifier
- func (n *Notifier) Notify(_ context.Context, title, body string)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Notifier ¶

type Notifier struct {
	// contains filtered or unexported fields
}

Notifier sends notifications to a shoutrrr URL.

func New ¶

func New(url string, log zerolog.Logger) *Notifier

New returns a Notifier. url may be empty (no-op). An unparseable URL disables notifications with a warning rather than failing startup.

func (*Notifier) Notify ¶

func (n *Notifier) Notify(_ context.Context, title, body string)

Notify delivers a message asynchronously. The title is passed as a shoutrrr param so services that support it (Discord embeds, ntfy/Telegram headers) show it prominently. Failures are logged, never fatal.

Source Files ¶

View all Source files

notify.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL