1Dist::Zilla::Plugin::GiUtsVeerrsCioonntCrhiebcuktCeDJdiMs(Pt3e:)r:lZiDlolcau:m:ePnltuagtiino:n:GitVersionCheckCJM(3)
2
6 Dist::Zilla::Plugin::GitVersionCheckCJM - Ensure version numbers are
7 up-to-date
8
10 This document describes version 4.27 of
11 Dist::Zilla::Plugin::GitVersionCheckCJM, released December 17, 2017 as
12 part of Dist-Zilla-Plugins-CJM version 6.000.
13
15 In your dist.ini:
16 [GitVersionCheckCJM]
18
20 This plugin makes sure that module version numbers are updated as
21 necessary. In a distribution with multiple module, I like to update a
22 module's version only when a change is made to that module. In other
23 words, a module's version is the version of the last distribution
24 release in which it was modified.
25 This plugin checks each module in the distribution, and makes sure that
27 it matches one of two conditions:
28 1. There is a tag matching the version, and the last commit on that
30 module is included in that tag.
31 2. The version matches the distribution's version, and that version
33 has not been tagged yet (i.e., the distribution has not been
34 released).
35 If neither condition holds, it prints an error message. After checking
37 all modules, it aborts the build if any module had an error.
38
40 finder
41 This FileFinder provides the list of modules that will be checked. The
42 default is ":InstallModules". The "finder" attribute may be listed any
43 number of times.
44 single_version
46 If set to a true value, all modules in the distribution must have the
47 distribution's version. The default is false, which allows unchanged
48 modules to retain the version of the distribution in which they were
49 last changed.
50
52 GitVersionCheckCJM requires Dist::Zilla (6 or later). It also requires
53 Git::Wrapper, although it is only listed as a recommended dependency
54 for the distribution (to allow people who don't use Git to use the
55 other plugins.)
56
58 None reported.
59
61 No bugs have been reported.
62
64 Christopher J. Madsen "<perl AT cjmweb.net>"
65 Please report any bugs or feature requests to
67 "<bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org>" or through the web
68 interface at
69 <http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM>.
70 You can follow or contribute to Dist-Zilla-Plugins-CJM's development at
72 <https://github.com/madsen/dist-zilla-plugins-cjm>.
73
75 This software is copyright (c) 2017 by Christopher J. Madsen.
76 This is free software; you can redistribute it and/or modify it under
78 the same terms as the Perl 5 programming language system itself.
79
81 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
82 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
83 WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
84 PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
85 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
86 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
87 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
88 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
89 NECESSARY SERVICING, REPAIR, OR CORRECTION.
90 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
92 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
93 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE
94 TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
95 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
96 SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
97 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
98 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
99 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
100 DAMAGES.
101perl v5.32.1 202D1i-s0t1:-:2Z7illa::Plugin::GitVersionCheckCJM(3)