NAME¶
Dist::Zilla::Plugin::Git::NextVersion - provide a version number by bumping the
last git release tag
VERSION¶
version 2.025
SYNOPSIS¶
In your
dist.ini:
[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
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
"version" parameter for your distribution.
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.)
The plugin accepts the following options:
- •
- "first_version" - if the repository has no tags at all, this
version is used as the first version for the distribution. It defaults to
"0.001".
- •
- "version_by_branch" - 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.
- •
- "version_regexp" - regular expression that matches a tag
containing a version. It must capture the version into $1. Defaults to
^v(.+)$ which matches the default "tag_format" from the Git::Tag
plugin. If you change "tag_format", you must set a
corresponding "version_regexp".
You can also set the "V" 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.
$ V=1.000 dzil release
Because tracing history takes time, if you use the "version_by_branch"
option, Git::NextVersion will create a
.gitnxtver_cache file in your
repository to track the highest version number that is an ancestor of the HEAD
revision. You should add
.gitnxtver_cache to your
.gitignore
file. It will automatically be pruned from the distribution.
AUTHOR¶
Jerome Quelin
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2009 by Jerome Quelin.
This is free software; you can redistribute it and/or modify it under the same
terms as the Perl 5 programming language system itself.