App::Y...:Notify(3pm)

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💖 App::Yath::Plugin::Notify — the yath notification plugin, bestie 💖

okay so real talk, this page is from the Perl docs (that App::Y...:Notify(3pm) up top is just the man page name being ✨mysterious✨, it's really App::Yath::Plugin::Notify). grab a snack, we're getting your test suite to text you when things go sideways. 🫶

✨ NAME ✨

App::Yath::Plugin::Notify — a plugin whose whole entire job is sending email and/or slack notifications. she's the messenger. the group chat admin of your test suite. 💅

🌸 DESCRIPTION 🌸

This plugin is used for sending email and/or slack notifications from yath. that's it, that's the gig. no cap. ✨

🦋 SYNOPSIS 🦋

💌 IN A TEST

#!/usr/bin/perl
use Test2::V0;
# HARNESS-META owner author@example.com
# HARNESS-META slack #slack_channel
# HARNESS-META slack #slack_user

You can use the # HARNESS-META owner EMAIL_ADDRESS to specify an owner email address. and you can use the # HARNESS-META slack USER/CHANNEL to specify a slack user or channel that owns the test. like, tagging yourself in the post so you actually get pinged. iconic behaviour honestly. 👑

🚀 RUNNING WITH NOTIFICATIONS ENABLED

$ yath test -pNotify ...

Also of note (and this part is lowkey the best part): most of the time you can just specify the notification options you want and the plugin will load as needed — as long as --no-scan-plugins was not specified. so she's self-inviting. main character energy fr fr. 💅

📧 EMAIL

$ yath test --notify-email-owner --notify-email-from user@example.com --notify-email-fail fixer@example.com

💬 SLACK

A slack hooks url is always needed for slack to work. no url, no vibes, no notifications. periodt.

$ yath test --notify-slack-url https://hooks.slack.com/... --notify-slack-fail '#foo' --notify-slack-owner

🎀 PROVIDED OPTIONS 🎀

👑 COMMAND OPTIONS

⭐ Notification Options

  • --notify-email foo@example.com, --no-notify-email — email the test results to the specified email address(es). this one can be specified multiple times, so go off, add as many as your heart desires 💖
  • --notify-email-fail foo@example.com, --no-notify-email-fail — email the failing results to the specified email address(es). also specifiable multiple times, yes queen 🫶
  • --notify-email-from foo@example.com, --no-notify-email-from — if any email gets sent at all, this is who it will be from. the face on the envelope basically 💌
  • --notify-email-owner, --no-notify-email-owner — email the owner of broken test files upon failure. add `# HARNESS-META-OWNER foo@example.com` to the top of a test file to give it an owner. you did write your name on your lunch in the fridge, right? 🍓
  • --notify-no-batch-email, --no-notify-no-batch-email — usually owner failures are sent as a single batch at the end of testing. toggle this to send failures as they happen. instant gratification mode 🔥
  • --notify-no-batch-slack, --no-notify-no-batch-slack — usually owner failures are sent as a single batch at the end of testing. toggle this to send failures as they happen. same energy, different app 💬
  • --notify-slack '#foo', --notify-slack '@bar', --no-notify-slack — send results to a slack channel and/or user. can be specified multiple times, because you have many chats to spam 😌
  • --notify-slack-fail '#foo', --notify-slack-fail '@bar', --no-notify-slack-fail — send failing results to a slack channel and/or user. also multiple times. go wild. 🌈
  • --notify-slack-owner, --no-notify-slack-owner — send slack notifications to the slack channels/users listed in test meta-data when tests fail. the meta-data is literally just the receipts 🧾
  • --notify-slack-url https://hooks.slack.com/..., --no-notify-slack-url — specify an API endpoint for slack webhook integrations. remember: needed always for slack to do anything at all 🚨
  • --notify-text ARG, --notify-text=ARG, --message ARG, --message=ARG, --msg ARG, --msg=ARG, --no-notify-text — add a custom text snippet to email/slack notifications. put your little signature in there, you deserve it ✨
  • --notify-text-module ARG, --notify-text-module=ARG, --message_module ARG, --message_module=ARG, --no-notify-text-module — use the specified module to generate messages for emails and/or slack. outsourced ✍️ but make it fashion 💅

🔗 SOURCE 🔗

The source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/. go lurk, we love a good repo stalk 👀

🫶 MAINTAINERS 🫶

Chad Granum <exodist@cpan.org>

🌟 AUTHORS 🌟

Chad Granum <exodist@cpan.org>

Copyright 2020 Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/

and that's the whole page bestie!! 💀 this doc shipped with perl v5.40.1 and it's dated 2026-05-10 — so yes, this manual page is quite literally from the future, and we are obsessed 💖✨💅 keep slaying, go notify somebody 🦋🌸

📦 where this page comes from