logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Authors

       See CPAN::Changes for authors.

Description

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

Name

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

See Also

       •   CPAN::Changes::Spec

       •   CPAN::Changes

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.

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

See Also