diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 53 |
1 files changed, 45 insertions, 8 deletions
@@ -5,7 +5,7 @@ NAME VERSION - version 0.14 + version 0.20 SYNOPSIS @@ -119,6 +119,10 @@ DESCRIPTION METHODS + BUILD + + Provides validations after object creation. + munge_files Override the default provided by Dist::Zilla::Role::FileMunger to @@ -127,7 +131,7 @@ METHODS munge_file - tells which files to munge, see Dist::Zilla::Role::FileMunger + tells which files to munge, see Dist::Zilla::Role::FileMunger. finder @@ -144,11 +148,28 @@ PROPERTIES For version numbers that have an underscore in them, add this line immediately after the our version assignment: - $VERSION = eval $VERSION; + $VERSION = eval $VERSION; This is arguably the correct thing to do, but changes the line numbering of the generated Perl module or source, and thus optional. + semantic_version + + Setting this property to "true" (1) will set the version of the + module/distribution to properly use semantic versioning. It will also + expect that you setup version with a v-string, without adding quotes. + For example: + + version = v0.0.1 + + Beware you can't setup both underscore_eval_version and + semantic_version since both are mutually exclusive: if you try, your + code is going to die. + + For more details, check this blog + <https://weblog.bulknews.net/how-to-correctly-use-semantic-version-vx-y-z-in-perl-modules-eb08568ab911> + for more details about using semantic version with Perl. + skip_main_module Set to true to ignore the main module in the distribution. This @@ -156,6 +177,16 @@ PROPERTIES Dist::Zilla::Plugin::VersionFromMainModule to obtain the version number instead of the dist.ini file. + overwrite + + When enabled, this option causes any match of the # VERSION comment + to first check for an existing our $VERSION = ...; on the same line, + and if found, overwrite the value in the existing statement. (the + comment still gets modified for trial releases) + + Currently, the value must be a single Perl token such as a string or + number. + BUGS Please report any bugs or feature requests on the bugtracker website @@ -166,10 +197,20 @@ BUGS CONTRIBUTORS - * Alexandr Ciornii <alexchorny@gmail.com> + * Alceu Rodrigues de Freitas Junior <alceu.junior@quintoandar.com.br> + + * Ian Sealy <git@iansealy.com> + + * Michael Conrad <mike@nrdvana.net> + + * Michael Jemmeson <mjemmeson@cpan.org> * Stephan Loyd <stephanloyd9@gmail.com> + * Alceu Rodrigues de Freitas Junior <arfreitas@cpan.org> + + * Alexandr Ciornii <alexchorny@gmail.com> + * Alexei Znamensky <russoz@cpan.org> * Christian Walde <walde.christian@googlemail.com> @@ -184,10 +225,6 @@ CONTRIBUTORS * Graham✈️✈️ <plicease@cpan.org> - * Ian Sealy <git@iansealy.com> - - * Michael Jemmeson <mjemmeson@cpan.org> - AUTHORS * Caleb Cushing <xenoterracide@gmail.com> |