NAME

Dist::Zilla::Plugin::Git::Describe - add the results of `git describe` (roughly) to your main module

VERSION

version 0.008

SYNOPSIS

in dist.ini

[Git::Describe]

DESCRIPTION

This plugin will add the long-form git commit description for the current repo to the dist's main module as a comment. It may change, in the future, to put things in a package variable, or to provide an option.

It inserts this in the same place that PkgVersion would insert a version.

PERL VERSION

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

ATTRIBUTES

on_package_line

If true, then the comment is added to the same line as the package declaration. Otherwise, it is added on its own line, with an additional blank line following it. Defaults to false.

SEE ALSO

PodVersion

AUTHOR

Ricardo Signes <cpan@semiotic.systems>

CONTRIBUTORS

  • Karen Etheridge <ether@cpan.org>

  • Mikko Koivunalho <mikkoi@cpan.org>

  • Ricardo Signes <rjbs@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Ricardo Signes.

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