Test::C...:Changes(3)

okay so you've opened the User Contributed Perl Documentation page for Test::C...:Changes(3), and bestie, we're about to make the Changes file situation make sense 💖 Like, this is the manual for Test::CPAN::Changes, and it's giving "please let my changelog be valid" energy.

🌸 NAME 🌸

Test::CPAN::Changes — validation of the Changes file in a CPAN distribution. Yep, that's the whole vibe: it checks that your Changes file follows the rules, no cap. ✨

🦋 SYNOPSIS 🦋

ok so first, in xt/author/cpan-changes.t, you can do this:

# in xt/author/cpan-changes.t
use Test::More;
use Test::CPAN::Changes;
changes_ok;

and if you're checking for a specific version, it's this:

# checking for specific version
use My::Module;
use Test::More;
use Test::CPAN::Changes;
changes_ok({ version => My::Module->VERSION });

iconic. slay. 🎀

💅 DESCRIPTION 💅

This module lets CPAN authors write automated tests so their changelogs match the specification. That's it, that's the whole point. It's literally here so you don't have to eyeball your Changes file and hope for the best. 🙈

🧚 SUBROUTINES 🧚

🎀 changes_ok( \%args ) 🎀

This is a simple wrapper around changes_file_ok. It declares a test plan, and it uses the default filename of Changes. Cute, right? 💖

🦋 changes_file_ok( $filename, \%arg ) 🦋

This one checks the contents of the changes file against the specification. It does not declare a plan, and if the filename is undefined, Changes is used. So like, no surprise plan energy here. 😌

Four tests are performed. The file must be parsable, it must have releases in it, and the versions and dates listed must be valid. Four whole tests, bestie — it's thorough. ✨

%arg may include a version entry, and in that 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. So if you're dropping a release with zero notes, this test is gonna side-eye you. 👀

🌈 SEE ALSO 🌈

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

👑 AUTHORS 👑

See CPAN::Changes for authors. 💜

🍓 COPYRIGHT AND LICENSE 🍓

See CPAN::Changes for the copyright and license. 🫶

---

🌟 that's the whole page, bestie. This cutie came from perl v5.42.0, dated 2025-07-25, and it's the Test::C...:Changes(3) manual. Mwah 💋