mercurial_update_version 0.3.2

Mercurial Update Version Extension

No more manual version number editing.

Whenever you issue hg tag, this extension scans your repository for files containing various kinds of VERSION = lines, updates those constants appropriately, commits the change, and only then tags the release.

Functionality can be enabled per-repository or (via ~/.hgrc) for many repositories at once (so you don’t need to remember about activating it on every created, or cloned repository).

Installation

Recommended way:

sudo pip install mercurial_update_version

(prepend with sudo if necessary). After installation make it available (this does not yet make it working) by writing in your ~/.hgrc:

[extensions]
update_version =

Then enable it using one of the methods below.

Alternatively: install mercurial_extension_utils, download update_version.py from this repository, and save it somewhere, write update_version = /path/to/update_version.py in your ~/.hgrc.

Enabling per-repository

In repository .hg/hgrc write:

[update_version]
active = true
language = python
tagfmt = dotted

(of course using appropriate settings). Here:

• language implies which files are worth checking, and what syntax do the version containing lines have,

• tagfmt describes expected tag syntax (and how to extract actual version number from the tag).

For example, language = python means looking for setup.py, __init__.py and version.py files anywhere inside the repository, and scan for lines looking like VERSION = "1.2.3", while tagfmt = dotted means you tag with dotted numbers, like hg tag 1.0.9.

Both languages and tag formats are configurable, extension brings some sane defaults but they can be overridden, and new styles can be defined. See below.

Enabling for many repositories at once

In ~/.hgrc write something like:

[update_version]
pydev.active_on = ~/sources/pymodules, ~/work/python
pydev.language = python
pydev.tagfmt = dotted
myperl.active_on = ~/scripts, ~/work/scripts
myperl.language = perl
myperl.tagfmt = dashed

Key prefixes (pydev and myperl) are used only to group three settings together (use any names you like).

In both cases:

• active_on lists directory trees to which given rule can be applied (absolute paths, ~ and ~user are allowed),

• language and tagfmt define which language settings and which tag format to use for those directories.

Using

After enabling the extension:

• ensure your code have some initial version variables (0.0 is often reasonable initial value)

• simply hg tag «appropriate-tag».

Note that:

• extension disables itself when tag is placed by revision (hg tag -r «version-no» «tag»),

• if tag does not match pattern, it warns you and also does nothing.

Local tags (rarely used feature) are also ignored.

Predefined languages

The language setting defines:

• which files to check and patch (by filename patterns)

• what is the appropriate constant format and name

The following languages are currently supported:

python

Look for files named setup.py, __init__.py or version.py (anywhere inside repository). In those files, update lines looking like:

VERSION = '1.2.3'

(at least one dot - but can be more, both single and double-quotes are supported, just like various spacing and indentation).

Inserted version number is formatted in the same way (as dot-separated list of numbers), tag should contain at least two-part version number to be used.

perl

Look for files named *.pl, *.pm and *.pod around repository. If found, look for lines like:

our $VERSION = '1.00';
my $VERSION = '11.72';
use constant VERSION => '21.3374';

(exactly one dot expected, various spacing and indentation allowed, double quotes allowed) and also:

Version 1.23

(usually met in POD sections).

Also, look for dist.ini and if found, fix lines like:

version = 0.02

Two kinds of tags numbers are supported. If tag contains two-item version, it is left as is (tag 1.0 results in version 1.0, dashed tag 1-03 brings 1.03). If tag has three parts, first is left before the dot while second and third each get two digits after the dot (tag 1.7.2 is translated into version 1.0702, tag 17-0-9 into 17.0009). Other tags are invalid.

Support for further languages is planned, feel free to suggest them.

Predefined tag formats

dotted

Tags like 1.0, 1.0.3, 11.17.34.

dashed

Tags like 1-0, 1-0-3, 11-17-34.

pfx-dotted

Tags like mylib-1.0 or sth_11.3.17: alphanumeric string, dash or underscore, then actual version as in dotted.

pfx-dashed

Tags like mylib-1-0 or sth_11-3-17: alphanumeric string, dash or underscore, then actual version as in dashed. leading part must not end with digit.

Custom languages

Not yet supported, but planned (defining new language by configuration settings, or overriding some default language characteristics). The general idea is to have some reasonable defaults built-in, but allow reconfiguration.

Custom tag formats

Not yet supported, but planned (defining new tag format by configuration settings).

Commands

Extension mainly work by augmenting hg tag. The command:

hg tag_version_test 1.0

does dry-run check – lists which files would be checked, whether version lines were found in them, and how would they be fixed.

History

See HISTORY.txt

Development, bug reports, enhancement suggestions

Development is tracked on BitBucket, see http://bitbucket.org/Mekk/mercurial-update_version/

Use BitBucket issue tracker for bug reports and enhancement suggestions.

Additional notes

Information about this extension is also available on Mercurial Wiki: http://mercurial.selenic.com/wiki/UpdateVersionExtension