NAME

Dist::Zilla::Plugin::TrialVersionComment - Add a "# TRIAL" comment after your version declaration in trial releases

VERSION

version 0.007

SYNOPSIS

In your dist.ini:

    [TrialVersionComment]

DESCRIPTION

This is a Dist::Zilla plugin that munges your .pm files to add a # TRIAL comment after $VERSION assignments, if the release is --trial.

If the distribution is not a --trial release (i.e. release_status in metadata is stable), this plugin does nothing.

Other plugins that munge versions into files also add the # TRIAL comment (such as [PkgVersion], [OurPkgVersion], and [RewriteVersion], so you would generally only need this plugin if you added the version yourself, manually.

Nothing currently parses these comments, but the idea is that things like Module::Metadata might make use of this in the future.

PURPOSE

This is a rather silly plugin, and doesn't really add any value. I suppose if you are adding $VERSION statements with [PkgVersion] it could be useful, but in that case I think I'd rather patch [PkgVersion] to add the comment as well, rather than going to all the effort of re-parsing the perl document again. I only really wrote this as an exercise in using PPI, to help diagnose some issues I was seeing with Acme::LookOfDisapproval and utf8-encoded perl code.

ACKNOWLEDGEMENTS

Inspiration for this module came about through multiple toolchain conversations with David Golden (xdg).

SEE ALSO

SUPPORT

Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-TrialVersionComment@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.

I am also usually active on irc, as 'ether' at irc.perl.org.

AUTHOR

Karen Etheridge <ether@cpan.org>

CONTRIBUTOR

David Golden <dagolden@cpan.org>

COPYRIGHT AND LICENCE

This software is copyright (c) 2014 by Karen Etheridge.

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