Scroll to navigation

Test::CPAN::Changes(3pm) User Contributed Perl Documentation Test::CPAN::Changes(3pm)

NAME

Test::CPAN::Changes - Validation of the Changes file in a CPAN distribution

SYNOPSIS

  # 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 });

DESCRIPTION

This module allows CPAN authors to write automated tests to ensure their changelogs match the specification.

SUBROUTINES

changes_ok( \%args )

Simple wrapper around "changes_file_ok". Declares a test plan, and uses the default filename of "Changes".

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, "Changes" is used.

Four tests are performed. The file must be parsable, must have releases in it, and the versions and dates listed must be valid.

%arg may include a version 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.

SEE ALSO

  • CPAN::Changes::Spec
  • CPAN::Changes

AUTHORS

See CPAN::Changes for authors.

COPYRIGHT AND LICENSE

See CPAN::Changes for the copyright and license.

2024-05-14 perl v5.38.2