module-version-t

(Check or update versions of embedded Perl modules)

SYNOPSIS

module-version-t [--update]

REQUIREMENTS

Perl 5.12 or later.

DESCRIPTION

This script has a dual purpose as either a test script or a utility script. The intent is to assist with maintaining consistent versions between a larger primarily C project and any embedded Perl modules, supporting both the package keyword syntax introduced in Perl 5.12 or the older explicit setting of a $VERSION variable.

As a test, it reads the current version of a package from the CHANGELOG.md file and then looks for any Perl modules in perl/lib. As a special exception, if the package name as determined from the CHANGELOG.md file is rra-c-util, it looks for Perl modules anywhere under the current directory instead. If it finds any, it checks that the version number of the Perl module matches the version number of the package from the CHANGELOG.md file. These test results are reported with Test::More, suitable for any TAP harness.

As a utility script, when run with the --update option, it similarly finds all Perl modules in perl/lib (or tests/tap/perl per above) and then rewrites their version setting to match the version of the package as determined from the CHANGELOG.md file.

OPTIONS

-u, --update

Rather than test the Perl modules for the correct version, update all Perl modules found in the tree under perl/lib to the current version from the CHANGELOG.md file.

AUTHOR

Russ Allbery <eagle@eyrie.org>

COPYRIGHT AND LICENSE

Copyright 2013 The Board of Trustees of the Leland Stanford Junior University

Copyright 2014, 2016, 2019-2021, 2024 Russ Allbery <eagle@eyrie.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

This module is maintained in the rra-c-util package. The current version is available from <https://www.eyrie.org/~eagle/software/rra-c-util/>.

Last spun 2024-02-25 from POD modified 2024-02-11