I did a push today and here's a rationale for some changes I've made to
former default.
There's now a lil function in version.py that returns version string.
Setuptools allows for two kind of additional version data: so-called
"pre-release tag" and "post-release tag". Pre-release tags are default
and can work with automatic "dev" suffix addition. However, setuptools
then assumes a package counts as a pre-release of future version. This
may work for projects with established release schedule, where it is
known beforehand what major version number will the next version get.
Allura seem to rely on continuous release, differentiated only by git
tags, so the scheme used by version() uses data from git describe as a
setuptools post-release tag. I've also kept it compatible with maj,min
versioning scheme, in case it'll be used in the future.
Tests seem to work out of former source tree. The only thing needed is
some adjustment of paths in test.ini. I came to a thought that this
should be explained, and ended up writing a full README adding this and
a bunch of other info. It may require some grammar fixes, as I'm not a
native english writer. I used reStructuredText, even though Allura uses
Markdown, because PyPI expects reST readmes. I may add reST support to
Allura later, or if it's already there - some kind of heuristics.
Finally, I've retained the history of changes from Allura repository -
it may be useful, even if for future reference only. One side-effect of
using git filter-branch with --subdirectory-filter was that the output
is ForgeHg/*, not ForgeHg/ itself. I find it better option in a separate
repository, so I've left it as is. Should work well within former source
tree structure anyways.
- Peter
