.\" -*- 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::Tag 3pm"
.TH Dist::Zilla::Plugin::Git::Tag 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::Tag \- Tag the new version
.SH VERSION
.IX Header "VERSION"
version 2.049
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In your \fIdist.ini\fR:
.PP
.Vb 3
\&    [Git::Tag]
\&    tag_format  = v%V       ; this is the default
\&    tag_message = v%V       ; this is the default
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Once the release is done, this plugin will record this fact in git by
creating a tag.  By default, it makes an annotated tag.  You can set
the \f(CW\*(C`tag_message\*(C'\fR attribute to change the message.  If you set
\&\f(CW\*(C`tag_message\*(C'\fR to the empty string, it makes a lightweight tag.
.PP
It also checks before the release to ensure the tag to be created
doesn't already exist.  (You would have to manually delete the
existing tag before you could release the same version again, but that
is almost never a good idea.)
.SS "Plugin options"
.IX Subsection "Plugin options"
The plugin accepts the following options:
.IP \(bu 4
tag_format \- format of the tag to apply. Defaults to \f(CW\*(C`v%V\*(C'\fR.
.IP \(bu 4
tag_message \- format of the tag annotation. Defaults to \f(CW\*(C`v%V\*(C'\fR.
Use \f(CW\*(C`tag_message\ =\*(C'\fR to create a lightweight tag.
The formatting codes
used in \f(CW\*(C`tag_format\*(C'\fR and \f(CW\*(C`tag_message\*(C'\fR 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.
.IP \(bu 4
branch \- which branch to tag. Defaults to the current branch.
.IP \(bu 4
signed \- whether to make a GPG-signed tag, using the default
e\-mail address's key. Consider setting \f(CW\*(C`user.signingkey\*(C'\fR if \f(CW\*(C`gpg\*(C'\fR
can't find the correct key:
.Sp
.Vb 1
\&    $ git config user.signingkey 450F89EC
.Ve
.SH METHODS
.IX Header "METHODS"
.SS tag
.IX Subsection "tag"
.Vb 1
\&    my $tag = $plugin\->tag;
.Ve
.PP
Return the tag that will be / has been applied by the plugin. That is,
returns \f(CW\*(C`tag_format\*(C'\fR as completed with the real values.
.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.