This repository has been archived by the owner on Jun 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
no line insertion and does Package version with our
License
xenoterracide/Dist-Zilla-Plugin-OurPkgVersion
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
NAME Dist::Zilla::Plugin::OurPkgVersion - no line insertion and does Package version with our VERSION version 0.005001 SYNOPSIS in dist.ini [OurPkgVersion] in your modules # VERSION DESCRIPTION This module was created as an alternative to Dist::Zilla::Plugin::PkgVersion and uses some code from that module. This module is designed to use a the more readable format "our $VERSION = $version;" as well as not change then number of lines of code in your files, which will keep your repository more in sync with your CPAN release. It also allows you slightly more freedom in how you specify your version. EXAMPLES in dist.ini ... version = 0.01; [OurPkgVersion] in lib/My/Module.pm package My::Module; # VERSION ... output lib/My/Module.pm package My::Module; our $VERSION = '0.01'; # VERSION ... please note that whitespace before the comment is significant so package My::Module; BEGIN { # VERSION } ... becomes package My::Module; BEGIN { our $VERSION = '0.01'; # VERSION } ... while package My::Module; BEGIN { # VERSION } ... becomes package My::Module; BEGIN { our $VERSION = '0.01'; # VERSION } ... you can also add additional comments to your comment ... # VERSION: generated by DZP::OurPkgVersion ... becomes ... our $VERSION = '0.1.0'; # VERSION: generated by DZP::OurPkgVersion ... Also note, the package line is not in any way significant, it will insert the "our $VERSION" line anywhere in the file before "# VERSION" as many times as you've written "# VERSION" regardless of whether or not inserting it there is a good idea. OurPkgVersion will not insert a version unless you have "# VERSION" so it is a bit more work. If you make a trial release, the comment will be altered to say so: # VERSION becomes our $VERSION = '0.01'; # TRIAL VERSION METHODS munge_files Override the default provided by Dist::Zilla::Role::FileMunger to limit the number of files to search to only be modules and executables. munge_file tells which files to munge, see Dist::Zilla::Role::FileMunger BUGS Please report any bugs or feature requests on the bugtracker website https://github.com/xenoterracide/dist-zilla-plugin-ourpkgversion/issues When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. CONTRIBUTORS * Alexandr Ciornii <[email protected]> * Alexei Znamensky <[email protected]> * Christian Walde <[email protected]> * Christopher J. Madsen <[email protected]> * David Golden <[email protected]> AUTHOR Caleb Cushing <[email protected]> COPYRIGHT AND LICENSE This software is Copyright (c) 2013 by Caleb Cushing. This is free software, licensed under: The Artistic License 2.0 (GPL Compatible)
About
no line insertion and does Package version with our
Resources
License
Stars
Watchers
Forks
Packages 0
No packages published