.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Plugin::Git::Check 3pm"
.TH Dist::Zilla::Plugin::Git::Check 3pm 2024-01-20 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Dist::Zilla::Plugin::Git::Check \- Check your git repository before releasing
.SH VERSION
.IX Header "VERSION"
version 2.049
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In your \fIdist.ini\fR:
.PP
.Vb 6
\&    [Git::Check]
\&    allow_dirty = dist.ini
\&    allow_dirty = README
\&    changelog = Changes      ; this is the default
\&    build_warnings = 0       ; this is the default
\&    untracked_files = die    ; default value (can also be "warn" or "ignore")
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This plugin checks that your Git repo is in a clean state before releasing.
The following checks are performed before releasing:
.IP \(bu 4
there should be no files in the index (staged copy)
.IP \(bu 4
there should be no untracked files in the working copy
.IP \(bu 4
the working copy should be clean. The files listed in
\&\f(CW\*(C`allow_dirty\*(C'\fR can be modified locally, though.
.PP
If those conditions are not met, the plugin will die, and the release
will thus be aborted. This lets you fix the problems before continuing.
.PP
The plugin accepts the following options:
.IP \(bu 4
changelog \- the name of your changelog file. defaults to \fIChanges\fR.
.IP \(bu 4
allow_dirty \- a file that is allowed to have local
modifications.  This option may appear multiple times.  The default
list is \fIdist.ini\fR and the changelog file given by \f(CW\*(C`changelog\*(C'\fR.  You
can use \f(CW\*(C`allow_dirty =\*(C'\fR to prohibit all local modifications.
.IP \(bu 4
allow_dirty_match \- works the same as allow_dirty, but
matching as a regular expression instead of an exact filename.
.IP \(bu 4
build_warnings \- if 1, perform the same checks after every build,
but as warnings, not errors.  Defaults to 0.
.IP \(bu 4
untracked_files \- indicates what to do if there are untracked
files.  Must be either \f(CW\*(C`die\*(C'\fR (the default), \f(CW\*(C`warn\*(C'\fR, or \f(CW\*(C`ignore\*(C'\fR.
\&\f(CW\*(C`warn\*(C'\fR lists the untracked files, while \f(CW\*(C`ignore\*(C'\fR only prints the
total number of untracked files.
.SH SUPPORT
.IX Header "SUPPORT"
Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Git>
(or bug\-Dist\-Zilla\-Plugin\-Git@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Git@rt.cpan.org>).
.PP
There is also a mailing list available for users of this distribution, at
<http://dzil.org/#mailing\-list>.
.PP
There is also an irc channel available for users of this distribution, at
\&\f(CW\*(C`#distzilla\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR <irc://irc.perl.org/#distzilla>.
.SH AUTHOR
.IX Header "AUTHOR"
Jerome Quelin
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2009 by Jerome Quelin.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.