.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Plugin::Git::CommitBuild 3pm"
.TH Dist::Zilla::Plugin::Git::CommitBuild 3pm "2018-07-31" "perl v5.26.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::CommitBuild \- Check in build results on separate branch
.SH "VERSION"
.IX Header "VERSION"
version 2.045
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your \fIdist.ini\fR:
.PP
.Vb 5
\&    [Git::CommitBuild]
\&        ; these are the defaults
\&    branch = build/%b
\&    message = Build results of %h (on %b)
\&    multiple_inheritance = 0
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Once the build is done, this plugin will commit the results of the
build to a branch that is completely separate from your regular code
branches (i.e. with a different root commit).  This potentially makes
your repository more useful to those who may not have Dist::Zilla
and all of its dependencies installed.
.PP
The plugin accepts the following options:
.IP "\(bu" 4
branch \- String::Formatter string for where to commit the
build contents.
.Sp
A single formatting code (\f(CW%b\fR) is defined for this attribute and will be
substituted with the name of the current branch in your git repository.
.Sp
Defaults to \f(CW\*(C`build/%b\*(C'\fR, but if set explicitly to an empty string
causes no build contents checkin to be made.
.IP "\(bu" 4
release_branch \- String::Formatter string for where to commit the
build contents
.Sp
Same as \f(CW\*(C`branch\*(C'\fR, but commit the build content only after a release. No
default, meaning no release branch.
.IP "\(bu" 4
message \- String::Formatter string for what commit message
to use when committing the results of the build.
.Sp
This option supports five formatting codes:
.RS 4
.IP "\(bu" 4
\&\f(CW%b\fR \- Name of the current branch
.IP "\(bu" 4
\&\f(CW%H\fR \- Commit hash
.IP "\(bu" 4
\&\f(CW%h\fR \- Abbreviated commit hash
.IP "\(bu" 4
\&\f(CW%v\fR \- The release version number
.IP "\(bu" 4
\&\f(CW%t\fR \- The string \*(L"\-TRIAL\*(R" if this is a trial release
.RE
.RS 4
.RE
.IP "\(bu" 4
release_message \- String::Formatter string for what
commit message to use when committing the results of the release.
.Sp
Defaults to the same as \f(CW\*(C`message\*(C'\fR.
.IP "\(bu" 4
multiple_inheritance \- Indicates whether the commit containing
the build results should have the source commit as a parent.
.Sp
If false (the default), the build branch will be completely separate
from the regular code branches.  If set to a true value, commits on a
build branch will have two parents: the previous build commit and the
source commit from which the build was generated.
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted through the \s-1RT\s0 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>.
.PP
I am also usually active on irc, as 'ether' at \f(CW\*(C`irc.perl.org\*(C'\fR.
.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.