Dist::Zilla::Plugin::Git::Tag(3)

NAME
Dist::Zilla::Plugin::Git::Tag - tag the new version

VERSION
version 2.014

SYNOPSIS
In your dist.ini:

    [Git::Tag]
    tag_format  = v%v       ; this is the default
    tag_message = v%v       ; this is the default

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 "tag_message" attribute to change the message. If you set "tag_message" to the empty string, it makes a lightweight tag.

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.)

  Plugin options
The plugin accepts the following options:

•   tag_format - format of the tag to apply. Defaults to "v%v", see "Formatting options" below.

•   tag_message - format of the tag annotation. Defaults to "v%v", see "Formatting options" below. Use "tag_message = " to create a lightweight tag.

•   time_zone - the time zone to use with %d. Can be any time zone name accepted by DateTime. Defaults to "local".

•   branch - which branch to tag. Defaults to current branch.

•   signed - whether to make a GPG-signed tag, using the default e-mail address' key. Consider setting "user.signingkey" if "gpg" can't find the correct key:

        $ git config user.signingkey 450F89EC

  Formatting options
Some plugin options allow you to customize the tag content. You can use the following codes at your convenience:

"%{dd-MMM-yyyy}d"
    The current date. You can use any CLDR format supported by DateTime. A bare %d means "%{dd-MMM-yyyy}d".

%n  A newline

%N  The distribution name

"%{-TRIAL}t"
    Expands to -TRIAL (or any other supplied string) if this is a trial release, or the empty string if not. A bare %t means "%{-TRIAL}t".

%v  The distribution version

METHODS

  tag
    my $tag = $plugin->tag;

Return the tag that will be / has been applied by the plugin. That is, returns "tag_format" as completed with the real values.

AUTHOR
Jerome Quelin

COPYRIGHT AND LICENSE
This software is copyright (c) 2009 by Jerome Quelin.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.