.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Software::Release 3pm"
.TH Software::Release 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Software::Release \- Object representing a release of software.
.SH "VERSION"
.IX Header "VERSION"
version 0.03
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use DateTime;
\&    use Software::Release;
\&    use Software::Release::Change;
\&
\&    my $change = Software::Release::Change\->new(
\&        author => \*(Aqgphat\*(Aq,
\&        change_id => \*(Aqabc1234\*(Aq,
\&        date => DateTime\->now,
\&        description => \*(AqFrozzled the wozjob\*(Aq
\&    );
\&
\&    my $rel = Software::Release\->new(
\&        version => \*(Aq0.1\*(Aq,
\&        name => \*(AqAngry Anteater\*(Aq,
\&        date => DateTime\->now,
\&    );
\&
\&    $rel\->add_to_changes($change);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Software::Release is a purely informational collection of objects that you
can use to represent a release of software.  Its original use-case was to
provide a contract between a git log parser and a formatter class that outputs
a changelog, but it may be useful to others to create bug trackers, dashboards
or whathaveyou.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "changes"
.IX Subsection "changes"
A list of Software::Release::Change objects for this release.
.SS "date"
.IX Subsection "date"
The date this software was released.
.SS "name"
.IX Subsection "name"
The name of this release.
.SS "version"
.IX Subsection "version"
The version of the release, as a string.
.SH "METHODS"
.IX Header "METHODS"
.SS "add_to_changes ($change)"
.IX Subsection "add_to_changes ($change)"
Add a change to this release's list of changes.
.SS "has_no_changes"
.IX Subsection "has_no_changes"
Returns true if this release's list of changes is empty.
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory G Watson <gphat@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Infinity Interactive, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.