.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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::Git::NextVersion 3pm" .TH Dist::Zilla::Plugin::Git::NextVersion 3pm "2020-09-13" "perl v5.30.3" "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::Git::NextVersion \- Provide a version number by bumping the last git release tag .SH "VERSION" .IX Header "VERSION" version 2.047 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In your \fIdist.ini\fR: .PP .Vb 4 \& [Git::NextVersion] \& first_version = 0.001 ; this is the default \& version_by_branch = 0 ; this is the default \& version_regexp = ^v(.+)$ ; this is the default .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This does the VersionProvider role. It finds the last version number from your Git tags, increments it using Version::Next, and uses the result as the \f(CW\*(C`version\*(C'\fR parameter for your distribution. .PP In addition, when making a release, it ensures that the version being released has not already been tagged. (The Git::Tag plugin has a similar check, but Git::Tag only checks for an exact match on the tag. Since Git::NextVersion knows how to extract version numbers from tags, it can find duplicates that Git::Tag would miss.) .PP The plugin accepts the following options: .IP "\(bu" 4 \&\f(CW\*(C`first_version\*(C'\fR \- if the repository has no tags at all, this version is used as the first version for the distribution. It defaults to \*(L"0.001\*(R". .IP "\(bu" 4 \&\f(CW\*(C`version_by_branch\*(C'\fR \- if true, consider only tags on the current branch when looking for the previous version. If you have a maintenance branch for stable releases and a development branch for trial releases, you should set this to 1. (You'll also need git version 1.6.1 or later.) The default is to look at all tags, because finding the tags reachable from a branch is a more expensive operation than simply listing all tags. .IP "\(bu" 4 \&\f(CW\*(C`version_regexp\*(C'\fR \- regular expression that matches a tag containing a version. It must capture the version into \f(CW$1\fR. Defaults to ^v(.+)$ which matches the default \f(CW\*(C`tag_format\*(C'\fR from the Git::Tag plugin. If you change \f(CW\*(C`tag_format\*(C'\fR, you \fBmust\fR set a corresponding \f(CW\*(C`version_regexp\*(C'\fR. .PP You can also set the \f(CW\*(C`V\*(C'\fR environment variable to override the new version. This is useful if you need to bump to a specific version. For example, if the last tag is 0.005 and you want to jump to 1.000 you can set V = 1.000. .PP .Vb 1 \& $ V=1.000 dzil release .Ve .PP Because tracing history takes time, if you use the \&\f(CW\*(C`version_by_branch\*(C'\fR option, Git::NextVersion will create a \&\fI.gitnxtver_cache\fR file in your repository root to track the highest version number that is an ancestor of the \s-1HEAD\s0 revision. You should add \fI.gitnxtver_cache\fR to your \fI.gitignore\fR file. It will automatically be pruned from the distribution. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker (or bug\-Dist\-Zilla\-Plugin\-Git@rt.cpan.org ). .PP There is also a mailing list available for users of this distribution, at . .PP There is also an irc channel available for users of this distribution, at \&\f(CW\*(C`#distzilla\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR . .SH "AUTHOR" .IX Header "AUTHOR" Jerome Quelin .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2009 by Jerome Quelin. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.