.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Dist::Zilla::Plugin::OurPkgVersion 3pm" .TH Dist::Zilla::Plugin::OurPkgVersion 3pm "2022-11-20" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Dist::Zilla::Plugin::OurPkgVersion \- No line insertion and does Package version with our .SH "VERSION" .IX Header "VERSION" version 0.21 .SH "SYNOPSIS" .IX Header "SYNOPSIS" in dist.ini .PP .Vb 1 \& [OurPkgVersion] .Ve .PP in your modules .PP .Vb 1 \& # VERSION .Ve .SH "DESCRIPTION" .IX Header "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 \f(CW\*(C`our $VERSION = $version;\*(C'\fR as well as not change then number of lines of code in your files, which will keep your repository more in sync with your \s-1CPAN\s0 release. It also allows you slightly more freedom in how you specify your version. .SS "\s-1EXAMPLES\s0" .IX Subsection "EXAMPLES" in dist.ini .PP .Vb 3 \& ... \& version = 0.01; \& [OurPkgVersion] .Ve .PP in lib/My/Module.pm .PP .Vb 3 \& package My::Module; \& # VERSION \& ... .Ve .PP output lib/My/Module.pm .PP .Vb 3 \& package My::Module; \& our $VERSION = \*(Aq0.01\*(Aq; # VERSION \& ... .Ve .PP please note that whitespace before the comment is significant so .PP .Vb 5 \& package My::Module; \& BEGIN { \& # VERSION \& } \& ... .Ve .PP becomes .PP .Vb 5 \& package My::Module; \& BEGIN { \& our $VERSION = \*(Aq0.01\*(Aq; # VERSION \& } \& ... .Ve .PP while .PP .Vb 5 \& package My::Module; \& BEGIN { \& # VERSION \& } \& ... .Ve .PP becomes .PP .Vb 5 \& package My::Module; \& BEGIN { \& our $VERSION = \*(Aq0.01\*(Aq; # VERSION \& } \& ... .Ve .PP you can also add additional comments to your comment .PP .Vb 3 \& ... \& # VERSION: generated by DZP::OurPkgVersion \& ... .Ve .PP becomes .PP .Vb 3 \& ... \& our $VERSION = \*(Aq0.1.0\*(Aq; # VERSION: generated by DZP::OurPkgVersion \& ... .Ve .PP you can also use perltidy's default static side comments (##) .PP .Vb 3 \& ... \& ## VERSION \& ... .Ve .PP becomes .PP .Vb 3 \& ... \& our $VERSION = \*(Aq0.1.0\*(Aq; ## VERSION \& ... .Ve .PP Also note, the package line is not in any way significant, it will insert the \&\f(CW\*(C`our $VERSION\*(C'\fR line anywhere in the file before \f(CW\*(C`# VERSION\*(C'\fR as many times as you've written \f(CW\*(C`# VERSION\*(C'\fR regardless of whether or not inserting it there is a good idea. OurPkgVersion will not insert a version unless you have \f(CW\*(C`# VERSION\*(C'\fR so it is a bit more work. .PP If you make a trial release, the comment will be altered to say so: .PP .Vb 1 \& # VERSION .Ve .PP becomes .PP .Vb 1 \& our $VERSION = \*(Aq0.01\*(Aq; # TRIAL VERSION .Ve .SH "METHODS" .IX Header "METHODS" .IP "\s-1BUILD\s0" 4 .IX Item "BUILD" Provides validations after object creation. .IP "munge_files" 4 .IX Item "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. .IP "munge_file" 4 .IX Item "munge_file" tells which files to munge, see Dist::Zilla::Role::FileMunger. .IP "finder" 4 .IX Item "finder" Override the default FileFinder for finding files to check and update. The default value is \f(CW\*(C`:InstallModules\*(C'\fR and \f(CW\*(C`:PerlExecFiles\*(C'\fR (when available; otherwise \f(CW\*(C`:ExecFiles\*(C'\fR) \&\*(-- see also Dist::Zilla::Plugin::ExecDir, to make sure the script files are properly marked as executables for the installer. .SH "PROPERTIES" .IX Header "PROPERTIES" .IP "underscore_eval_version" 4 .IX Item "underscore_eval_version" For version numbers that have an underscore in them, add this line immediately after the our version assignment: .Sp .Vb 1 \& $VERSION = eval $VERSION; .Ve .Sp This is arguably the correct thing to do, but changes the line numbering of the generated Perl module or source, and thus optional. .IP "semantic_version" 4 .IX Item "semantic_version" Setting this property to \*(L"true\*(R" (1) will set the version of the module/distribution to properly use semantic versioning. It will also expect that you setup \f(CW\*(C`version\*(C'\fR with a v\-string, without adding quotes. For example: .Sp .Vb 1 \& version = v0.0.1 .Ve .Sp Beware you can't setup both \f(CW\*(C`underscore_eval_version\*(C'\fR and \f(CW\*(C`semantic_version\*(C'\fR since both are mutually exclusive: if you try, your code is going to \f(CW\*(C`die\*(C'\fR. .Sp For more details, check this blog for more details about using semantic version with Perl. .IP "skip_main_module" 4 .IX Item "skip_main_module" Set to true to ignore the main module in the distribution. This prevents a warning when using Dist::Zilla::Plugin::VersionFromMainModule to obtain the version number instead of the \f(CW\*(C`dist.ini\*(C'\fR file. .IP "overwrite" 4 .IX Item "overwrite" When enabled, this option causes any match of the \f(CW\*(C`# VERSION\*(C'\fR comment to first check for an existing \f(CW\*(C`our $VERSION = ...;\*(C'\fR on the same line, and if found, overwrite the value in the existing statement. (the comment still gets modified for trial releases) .Sp Currently, the value must be a single Perl token such as a string or number. .IP "no_critic" 4 .IX Item "no_critic" When \f(CW\*(C`underscore_eval_version\*(C'\fR is used the generated code for dev versions may not technically be Perl::Critic compliant due to string eval, but is nevertheless pretty safe. This option will add the appropriate \f(CW\*(C`no critic\*(C'\fR directive to save you the hassle. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP 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. .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Alceu Rodrigues de Freitas Junior .IP "\(bu" 4 Ian Sealy .IP "\(bu" 4 Michael Conrad .IP "\(bu" 4 Michael Jemmeson .IP "\(bu" 4 Stephan Loyd .IP "\(bu" 4 Alceu Rodrigues de Freitas Junior .IP "\(bu" 4 Alexandr Ciornii .IP "\(bu" 4 Alexei Znamensky .IP "\(bu" 4 Christian Walde .IP "\(bu" 4 Christopher J. Madsen .IP "\(bu" 4 David Golden .IP "\(bu" 4 Graham Ollis .IP "\(bu" 4 Graham Ollis .IP "\(bu" 4 Graham✈️✈️ .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Caleb Cushing .IP "\(bu" 4 Grahan Ollis .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2019 by Caleb Cushing. .PP This is free software, licensed under: .PP .Vb 1 \& The Artistic License 2.0 (GPL Compatible) .Ve