1Dist::Zilla::Plugin::GiUts:e:rTaCgo(n3t)ributed Perl DocDuimsetn:t:aZtiilolna::Plugin::Git::Tag(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::Git::Tag - Tag the new version
7

VERSION

9       version 2.046
10

SYNOPSIS

12       In your dist.ini:
13
14           [Git::Tag]
15           tag_format  = v%V       ; this is the default
16           tag_message = v%V       ; this is the default
17

DESCRIPTION

19       Once the release is done, this plugin will record this fact in git by
20       creating a tag.  By default, it makes an annotated tag.  You can set
21       the "tag_message" attribute to change the message.  If you set
22       "tag_message" to the empty string, it makes a lightweight tag.
23
24       It also checks before the release to ensure the tag to be created
25       doesn't already exist.  (You would have to manually delete the existing
26       tag before you could release the same version again, but that is almost
27       never a good idea.)
28
29   Plugin options
30       The plugin accepts the following options:
31
32       ·   tag_format - format of the tag to apply. Defaults to "v%V".
33
34       ·   tag_message - format of the tag annotation. Defaults to "v%V".  Use
35           "tag_message =" to create a lightweight tag.  The formatting codes
36           used in "tag_format" and "tag_message" are documented under
37           Dist::Zilla::Role::Git::StringFormatter.
38
39       ·   time_zone - the time zone to use with %d.  Can be any time zone
40           name accepted by DateTime.  Defaults to "local".
41
42       ·   branch - which branch to tag. Defaults to the current branch.
43
44       ·   signed - whether to make a GPG-signed tag, using the default e-mail
45           address's key. Consider setting "user.signingkey" if "gpg" can't
46           find the correct key:
47
48               $ git config user.signingkey 450F89EC
49

METHODS

51   tag
52           my $tag = $plugin->tag;
53
54       Return the tag that will be / has been applied by the plugin. That is,
55       returns "tag_format" as completed with the real values.
56

SUPPORT

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

AUTHOR

70       Jerome Quelin
71

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