.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Test::CPAN::Changes 3pm"
.TH Test::CPAN::Changes 3pm 2024-03-02 "perl v5.38.2" "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
Test::CPAN::Changes \- Validation of the Changes file in a CPAN distribution
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  # in xt/author/cpan\-changes.t
\&  use Test::More;
\&  use Test::CPAN::Changes;
\&  changes_ok;
\&
\&  # checking for specific version
\&  use My::Module;
\&  use Test::More;
\&  use Test::CPAN::Changes;
\&  changes_ok({ version => My::Module\->VERSION });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module allows CPAN authors to write automated tests to ensure their
changelogs match the specification.
.SH SUBROUTINES
.IX Header "SUBROUTINES"
.SS "changes_ok( \e%args )"
.IX Subsection "changes_ok( %args )"
Simple wrapper around \f(CW\*(C`changes_file_ok\*(C'\fR. Declares a test plan, and uses the
default filename of \f(CW\*(C`Changes\*(C'\fR.
.ie n .SS "changes_file_ok( $filename, \e%arg )"
.el .SS "changes_file_ok( \f(CW$filename\fP, \e%arg )"
.IX Subsection "changes_file_ok( $filename, %arg )"
Checks the contents of the changes file against the specification. No plan
is declared and if the filename is undefined, \f(CW\*(C`Changes\*(C'\fR is used.
.PP
Four tests are performed.  The file must be parsable, must have releases in it,
and the versions and dates listed must be valid.
.PP
\&\f(CW%arg\fR may include a \fIversion\fR entry, in which case two additional tests are
performed.  The entry for that version must exist and have content.  This is
useful to ensure that the version currently being released has documented
changes.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
CPAN::Changes::Spec
.IP \(bu 4
CPAN::Changes
.SH AUTHORS
.IX Header "AUTHORS"
See CPAN::Changes for authors.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See CPAN::Changes for the copyright and license.