Softwa...Release(3pm)

💖 Software::Release — the whole vibe 💖

okay bestie, so this is Software::Release, a lil Perl module from the User Contributed Perl Documentation section (that's the 3pm part, iykyk). It's literally an object that represents a release of software. That's it. That's the girl. 🎀

---

✨ NAME ✨

Software::Release — an object representing a release of software. yes really, that's the whole name, we're not being mysterious about it 💅

---

🌸 VERSION 🌸

version 0.03 — she's small but she's mighty 🦋

---

🎀 SYNOPSIS 🎀

okay here's how you actually use her, no gatekeeping:

use DateTime;
use Software::Release;
use Software::Release::Change;

my $change = Software::Release::Change->new(
    author => 'gphat',
    change_id => 'abc1234',
    date => DateTime->now,
    description => 'Frozzled the wozjob'
);

my $rel = Software::Release->new(
    version => '0.1',
    name => 'Angry Anteater',
    date => DateTime->now,
);

$rel->add_to_changes($change);

like. look at her go. "Frozzled the wozjob" is genuinely iconic and I will not be hearing otherwise 😭✨

---

💜 DESCRIPTION 💜

So Software::Release is a purely informational collection of objects that you can use to represent a release of software. purely informational!! she does not do things, she is things, and honestly? main character energy. 👑

Her original use-case was to be a contract between a git log parser and a formatter class that outputs a changelog — like a little handshake agreement between two modules so neither one has to guess what the other wants. but she's flexible bestie, she may be useful to others for creating bug trackers, dashboards, or whathaveyou. whathaveyou!! the range!! 🌈

---

🫶 ATTRIBUTES 🫶

🍓 changes

A list of Software::Release::Change objects for this release. the receipts, the lore, the whole story of what happened 💅

🍓 date

The date this software was released. when she was born, basically 🎂

🍓 name

The name of this release. (Remember 'Angry Anteater'? yeah. names go hard here.) 🦋

🍓 version

The version of the release, as a string. string, bestie. noted. keep it a string. 🎀

---

⭐ METHODS ⭐

💫 add_to_changes ($change)

Add a change to this release's list of changes. you hand her a $change and she files it. that's it, that's the method, slay 💖

💫 has_no_changes

Returns true if this release's list of changes is empty. a little vibe check for "did literally anything happen here" 🙈 returns true = yes empty, no changes, nothing to see, no cap.

---

👑 AUTHOR 👑

Cory G Watson <gphat@cpan.org> — the legend herself, thank you for your service 🫡💜

---

🌸 COPYRIGHT AND LICENSE 🌸

This software is copyright (c) 2011 by Infinity Interactive, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. free software!! go off, redistribute her, she's generous like that ✨

---

ok real talk bestie: she's informational only, so don't come for her expecting her to do the release for you. she's the scrapbook, not the scissors. 💅

---

and that's the page, periodt. 🎀 built on perl v5.34.0, dated 2022-06-17, filed under Software::Release(3pm) in the User Contributed Perl Documentation. love her, use her, keep it a string. bye bestie 💖🦋✨