NAME
Dist::Zilla::Plugin::Git::Tag - tag the new version
VERSION
version 1.100760
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.)
The plugin accepts the following options:
tag_format - format of the tag to apply. Defaults to
v%v
.tag_message - format of the commit message. Defaults to
v%v
. Usetag_message =
to create a lightweight tag.
You can use the following codes in both options:
%{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
%v
-
the distribution version
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.