Dist::...Notify(3pm)

๐Ÿ“ฆ
version 0.004 ยท 2 versions
  • 0.004 ยท debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.004 ยท ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

๐Ÿ’Œ Dist::Zilla::Plugin::EmailNotify โ€” the manual, bestie edition

okay so you're on the Dist::...Notify(3pm) page, which means you want your dist release to slide into somebody's inbox. Say less. ๐Ÿ’–

VERSION: version 0.004 โœจ


๐ŸŒธ NAME ๐ŸŒธ

Dist::Zilla::Plugin::EmailNotify โ€” literally just sends an email when you release a dist. That's the whole job. She's focused. She's iconic. ๐Ÿ‘‘


๐Ÿ’ซ DESCRIPTION ๐Ÿ’ซ

This plugin lets you send an email when releasing. That's it, that's the vibe. No cap. ๐Ÿฆ‹


๐ŸŽ€ FIELDS ๐ŸŽ€

These are the lil config knobs you drop into your dist.ini, bestie.

๐Ÿ“ฎ from

Who is sending the email? ๐Ÿ‘€

[EmailNotify]
from = xsawyerx@cpan.org

๐Ÿงš recipient

Multiple single recipients. These will compose the 'to' field. So like, one per line, and she'll stitch 'em together for you. ๐Ÿ’…

[EmailNotify]
recipient = jack@myemail.com
recipient = jill@myemail.com

๐Ÿ’Œ to

Direct recipients string. This should be comma separated. fr fr, commas only.

[EmailNotify]
to = jack@myemail.com, jill@myemail.com

๐Ÿ“ cc

Any CC you may want. This should be comma separated. (Your boss wants to be in the loop, lowkey.)

[EmailNotify]
cc = myboss@myemail.com, jacksboss@myemail.com

๐Ÿ™ˆ bcc

Any BCC you may want. This should be comma separated. Sneaky sneaky, no one sees this one. ๐Ÿคซ

[EmailNotify]
bcc = topgun@myemail.com

๐Ÿ”ฅ ATTRIBUTES ๐Ÿ”ฅ

โญ to(Str)

The 'to' email field. Just a string. Simple. Gorgeous.

๐ŸŒˆ recipient(ArrayRef[Str])

This array reference of strings will be used to compose the 'to' email field.

It is used in case you want to comfortably write down the recipients instead of one long string. This is not provided for other fields โ€” so like, don't go looking for cc array magic, she doesn't do that. ๐Ÿ’€

๐Ÿ’œ from(Str)

The 'from' email field.

๐Ÿฉต cc(Str)

The 'cc' email field.

๐Ÿงก bcc(Str)

The 'bcc' email field.


๐Ÿ› ๏ธ METHODS/SUBROUTINES ๐Ÿ› ๏ธ

๐Ÿ“ง after_release

Method to actually send the email right after the 'release' process. Takes all the arguments, creates a body message text using the last change log entry, and sends the email using Email::Stuff. She read the changelog so you don't have to. main character energy honestly. โœจ

๐Ÿ”จ _build_to

Builder to take all the recipient attribute values and create a single string. Gluing them together like a true bestie. ๐Ÿซถ

๐Ÿงฉ mvp_multivalue_args

Internal, Config::MVP related. Creates a multivalue argument. You probably never touch this one โ€” it's giving backstage pass. ๐ŸŽซ


๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Sawyer X <xsawyerx@cpan.org> โ€” the legend herself. ๐Ÿ’–


This software is Copyright (c) 2016 by Sawyer X.

This is free software, licensed under:

The MIT (X11) License

and that's the whole page, babe โ€” this manual came to you courtesy of perl v5.34.0, dated 2022-06-13, from the Dist::...Notify(3pm) page itself. go forth and email people about your releases. slay. ๐Ÿ’…โœจ