1Test::CheckChanges(3pm)User Contributed Perl DocumentatioTnest::CheckChanges(3pm)
2
3
4

NAME

6       Test::CheckChanges - Check that the Changes file matches the
7       distribution.
8

VERSION

10       Version 0.14
11

SYNOPSIS

13        use Test::CheckChanges;
14        ok_changes();
15
16       You can make the test optional with
17
18        use Test::More;
19        eval { require Test::CheckChanges };
20
21        if ($@) {
22            plan skip_all => 'Test::CheckChanges required for testing the Changes file';
23        }
24        ok_changes();
25

DESCRIPTION

27       This module checks that you Changes file has an entry for the current
28       version of the Module being tested.
29
30       The version information for the distribution being tested is taken out
31       of the Build data, or if that is not found, out of the Makefile.
32
33       It then attempts to open, in order, a file with the name Changes or
34       CHANGES.
35
36       The Changes file is then parsed for version numbers.  If one and only
37       one of the version numbers matches the test passes.  Otherwise the test
38       fails.
39
40       A message with the current version is printed if the test passes,
41       otherwise dialog messages are printed to help explain the failure.
42
43       The examples directory contains examples of the different formats of
44       Changes files that are recognized.
45

FUNCTIONS

47       All functions listed below are exported to the calling namespace.
48
49   ok_changes( )
50           The ok_changes method takes no arguments and returns no value.
51

CHANGES FILE FORMAT

53       Currently this package parses 4 different types of "Changes" files.
54       The first is the common, free style, "Changes" file where the version
55       is first item on an unindented line:
56
57        0.01  Fri May  2 15:56:25 EDT 2008
58              - more info
59
60       The second type of file parsed is the Module::Changes::YAML format
61       changes file.
62
63       The third type of file parsed has the version number proceeded by an *
64       (asterisk).
65
66        Revision history for Perl extension Foo::Bar
67
68        * 1.00
69
70        Is this a bug or a feature
71
72       The fourth type of file parsed starts the line with the word Version
73       followed by the version number.
74
75        Version 6.00  17.02.2008
76         + Oops. Fixed version number. '5.10' is less than '5.9'. I thought
77           CPAN would handle this but apparently not..
78
79       There are examples of these Changes file in the examples directory.
80
81       Create an RT if you need a different format file supported.  If it is
82       not horrid, I will add it.
83
84       The Debian style "Changes" file will likely be the first new format
85       added.
86

BUGS

88       Please open an RT if you find a bug.
89
90       <http://rt.cpan.org/Public/Dist/Display.html?Name=Test-CheckChanges>
91

AUTHOR

93       "G. Allen Morris III" <gam3@gam3.net>
94

96       Copyright (C) 2008-2010 G. Allen Morris III, all rights reserved.
97
98       This program is free software; you can redistribute it and/or modify it
99       under the same terms as Perl itself.
100
101
102
103perl v5.38.0                      2023-07-21           Test::CheckChanges(3pm)
Impressum