NAME
Dist::Zilla::Plugin::GitVersionCheckCJM - Ensure version numbers are up-to-date
VERSION
This document describes version 4.27 of Dist::Zilla::Plugin::GitVersionCheckCJM, released December 17, 2017 as part of Dist-Zilla-Plugins-CJM version 6.000.
SYNOPSIS
In your dist.ini:
[GitVersionCheckCJM]DESCRIPTION
This plugin makes sure that module version numbers are updated as necessary. In a distribution with multiple module, I like to update a module's version only when a change is made to that module. In other words, a module's version is the version of the last distribution release in which it was modified.
This plugin checks each module in the distribution, and makes sure that it matches one of two conditions:
There is a tag matching the version, and the last commit on that module is included in that tag.
The version matches the distribution's version, and that version has not been tagged yet (i.e., the distribution has not been released).
If neither condition holds, it prints an error message. After checking all modules, it aborts the build if any module had an error.
ATTRIBUTES
finder
This FileFinder provides the list of modules that will be checked. The default is :InstallModules. The finder attribute may be listed any number of times.
single_version
If set to a true value, all modules in the distribution must have the distribution's version. The default is false, which allows unchanged modules to retain the version of the distribution in which they were last changed.
DEPENDENCIES
GitVersionCheckCJM requires Dist::Zilla (6 or later). It also requires Git::Wrapper, although it is only listed as a recommended dependency for the distribution (to allow people who don't use Git to use the other plugins.)
INCOMPATIBILITIES
None reported.
BUGS AND LIMITATIONS
No bugs have been reported.
AUTHOR
Christopher J. Madsen <perl AT cjmweb.net>
Please report any bugs or feature requests to <bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM.
You can follow or contribute to Dist-Zilla-Plugins-CJM's development at https://github.com/madsen/dist-zilla-plugins-cjm.
COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by Christopher J. Madsen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
DISCLAIMER OF WARRANTY
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 LICENSE, 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.