.\" -*- 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::Commit 3pm"
.TH Dist::Zilla::Plugin::Git::Commit 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::Commit \- Commit dirty files
.SH VERSION
.IX Header "VERSION"
version 2.049
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In your \fIdist.ini\fR:
.PP
.Vb 2
\&    [Git::Commit]
\&    changelog = Changes      ; this is the default
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Once the release is done, this plugin will record this fact in git by
committing changelog and \fIdist.ini\fR. The commit message will be taken
from the changelog for this release.  It will include lines between
the current version and timestamp and the next non-indented line,
except that blank lines at the beginning or end are removed.
.PP
\&\fBWarning:\fR If you are using Git::Commit in conjunction with the
NextRelease plugin,
\&\f(CW\*(C`[NextRelease]\*(C'\fR must come before \f(CW\*(C`[Git::Commit]\*(C'\fR (or \f(CW\*(C`[@Git]\*(C'\fR) in
your \fIdist.ini\fR or plugin bundle.  Otherwise, Git::Commit will commit
the \fIChanges\fR file before NextRelease has updated it.
.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 will be checked in if it is locally
modified.  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.
.IP \(bu 4
allow_dirty_match \- works the same as allow_dirty, but
matching as a regular expression(s) instead of an exact filename(s).
.IP \(bu 4
add_files_in \- a path that will have its new files checked in.
This option may appear multiple times. This is used to add files
generated during build-time to the repository, for example. The default
list is empty.
.Sp
Note: The files have to be generated between the phases BeforeRelease
<\-> AfterRelease, and after Git::Check + before Git::Commit.
.IP \(bu 4
commit_msg \- the commit message to use. Defaults to
\&\f(CW\*(C`v%V%n%n%c\*(C'\fR, meaning the version number and the list of changes.
The formatting codes
are documented under Dist::Zilla::Role::Git::StringFormatter.
.IP \(bu 4
time_zone \- the time zone to use with \f(CW%d\fR.  Can be any
time zone name accepted by DateTime.  Defaults to \f(CW\*(C`local\*(C'\fR.
.SH METHODS
.IX Header "METHODS"
.SS get_commit_message
.IX Subsection "get_commit_message"
This method returns the commit message.  The default implementation
reads the Changes file to get the list of changes in the just-released version.
.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.