1Dist::Zilla::Plugin::GiUts:e:rChCeocnkt(r3i)buted Perl DDoicsutm:e:nZtialtliao:n:Plugin::Git::Check(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::Git::Check - Check your git repository before
7       releasing
8

VERSION

10       version 2.047
11

SYNOPSIS

13       In your dist.ini:
14
15           [Git::Check]
16           allow_dirty = dist.ini
17           allow_dirty = README
18           changelog = Changes      ; this is the default
19           build_warnings = 0       ; this is the default
20           untracked_files = die    ; default value (can also be "warn" or "ignore")
21

DESCRIPTION

23       This plugin checks that your Git repo is in a clean state before
24       releasing.  The following checks are performed before releasing:
25
26       ·   there should be no files in the index (staged copy)
27
28       ·   there should be no untracked files in the working copy
29
30       ·   the working copy should be clean. The files listed in "allow_dirty"
31           can be modified locally, though.
32
33       If those conditions are not met, the plugin will die, and the release
34       will thus be aborted. This lets you fix the problems before continuing.
35
36       The plugin accepts the following options:
37
38       ·   changelog - the name of your changelog file. defaults to Changes.
39
40       ·   allow_dirty - a file that is allowed to have local modifications.
41           This option may appear multiple times.  The default list is
42           dist.ini and the changelog file given by "changelog".  You can use
43           "allow_dirty =" to prohibit all local modifications.
44
45       ·   allow_dirty_match - works the same as allow_dirty, but matching as
46           a regular expression instead of an exact filename.
47
48       ·   build_warnings - if 1, perform the same checks after every build,
49           but as warnings, not errors.  Defaults to 0.
50
51       ·   untracked_files - indicates what to do if there are untracked
52           files.  Must be either "die" (the default), "warn", or "ignore".
53           "warn" lists the untracked files, while "ignore" only prints the
54           total number of untracked files.
55

SUPPORT

57       Bugs may be submitted through the RT bug tracker
58       <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-
59       Git> (or bug-Dist-Zilla-Plugin-Git@rt.cpan.org <mailto:bug-Dist-Zilla-
60       Plugin-Git@rt.cpan.org>).
61
62       There is also a mailing list available for users of this distribution,
63       at <http://dzil.org/#mailing-list>.
64
65       There is also an irc channel available for users of this distribution,
66       at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
67

AUTHOR

69       Jerome Quelin
70

72       This software is copyright (c) 2009 by Jerome Quelin.
73
74       This is free software; you can redistribute it and/or modify it under
75       the same terms as the Perl 5 programming language system itself.
76
77
78
79perl v5.32.0                      2020-09-14Dist::Zilla::Plugin::Git::Check(3)
Impressum