NAME

Dist::Zilla::Role::Git::StringFormatter - Provide a String::Formatter for commit messages

VERSION

version 2.049

DESCRIPTION

This role is used within the Git plugins to format strings that may include the changes from the current release.

These formatting codes are available:

%c: The list of changes in the just-released version (read from "changelog"). It will include lines between the current version and timestamp and the next non-indented line, except that blank lines at the beginning or end are removed. It always ends in a newline unless it is the empty string.
"%{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
%V: The distribution version, but with a leading "v" removed if it exists.

ATTRIBUTES

changelog

The filename of your Changes file. (Must be provided by the class that consumes this role.)

time_zone

The time zone used with the %d code. The default is "local".

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

There is also a mailing list available for users of this distribution, at <http://dzil.org/#mailing-list>.

There is also an irc channel available for users of this distribution, at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.

AUTHOR

Jerome Quelin

COPYRIGHT AND LICENCE

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