Test::...Version(3pm)

✨ NAME ✨

okay bestie, listen up — this is Test::ConsistentVersion, a lil module (a Perl manpage in section 3pm, from the User Contributed Perl Documentation crew 🫶) whose whole entire job is making sure a CPAN distribution has consistent versioning. no cap. one version to rule them all, one version to bind them 💅

---

🌸 VERSION 🌸

This doc is describing Test::ConsistentVersion version 0.3.1 — write that down, bestie, we're literally about to talk about version consistency so it would be so embarrassing to forget it 📝

---

🎀 SYNOPSIS 🎀

this goes in a test file, babes:

use Test::More;

if ( not $ENV{TEST_AUTHOR} ) {
    my $msg = 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.';
    plan( skip_all => $msg );
}

eval "use Test::ConsistentVersion";
plan skip_all => "Test::ConsistentVersion required for checking versions" if $@;
Test::ConsistentVersion::check_consistent_versions();

see what's happening? you check the env var, you skip all cutely if it's not set, you try to load the module, you skip all again if it's not there, and then you actually run the check. it's giving responsible. it's giving ✨author test✨ energy.

---

🦋 DESCRIPTION 🦋

so the whole point of this module?? it exists so that other distribution authors can have consistent version numbers across all the modules in their distribution — and not just the modules, bestie, also the readme file and the changelog. the way that one mismatched version number can just ruin your whole release vibe... not on our watch 💖

---

👑 INTERFACE 👑

check_consistent_versions

check_consistent_versions()

this is the one (1) function and she's iconic for it. she goes around checking the various versions throughout the distribution to make sure they're all consistent. that's it. that's the whole job. lowkey the most honest function in Perl 🫡

---

💀 DIAGNOSTICS 💀

Nothing so far. (fr fr, nothing. ghost town. zero diagnostics. it's giving minimalism 🙈)

---

🌈 CONFIGURATION AND ENVIRONMENT 🌈

Test::ConsistentVersion requires no configuration files or environment variables. none. zero. nada. she just works, bestie, no setup arc needed 🧚

---

🍓 DEPENDENCIES 🍓

• perl 5.6 or greater
• Test::Builder
• autodie

Optional 💅

• Test::Pod::Content — for ensuring the module version matches that referenced in the POD.

---

💜 INCOMPATIBILITIES 💜

Perl 5.6 or greater is required. (yes this is also in DEPENDENCIES. yes she's saying it twice. she means it. do not test her on this ⚠️)

---

😭 BUGS AND LIMITATIONS 😭

No bugs have been reported. 🦋 (iconic behaviour honestly)

Please report any bugs or feature requests to <https://github.com/cebjyre/Test-ConsistentVersion/issues>.

bestie if you find a bug, GO TELL HER. don't just sit there in silence suffering. the issue tracker is right there 💌

---

⭐ AUTHOR ⭐

Glenn Fowler <cebjyre@cpan.org>

Thanks to <http://www.accelo.com>. 🫶

---

🔥 LICENCE AND COPYRIGHT 🔥

Copyright (c) 2021, Glenn Fowler <cebjyre@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. 👑

---

🌸 DISCLAIMER OF WARRANTY 🌸

okay bestie, deep breath, this part is ALL CAPS FOR A REASON and we do not soften it, we do not paraphrase it, we do not vibe our way around it. here it is, verbatim, exactly as the law gods intended:

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

---

and that's the whole page, bestie!! 🎀 this one was generated by perl v5.32.1 and dated 2021-11-06 — so if you're reading this from the future, hi, love u, pls don't @ me about the version numbers, that's literally this module's whole job 💅✨