entrouvert
/
plone.api
Archived
17
0
Fork 0
Code Issues Pull Requests Releases Activity

we should not break old habbits. no dot btw version and status! and fix the precedence of version strings, which was stated wrong here.

This commit is contained in:
Johannes Raggam 2014-02-14 15:10:19 +01:00
parent 71d99690bf
commit be292e7867
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contribute/conventions.rst
View File

@ -338,11 +338,19 @@ Versioning scheme
For software versions, use a sequence-based versioning scheme, which is
`compatible with setuptools <http://pythonhosted.org/setuptools/setuptools.html#specifying-your-project-s-version>`_::
MAJOR.MINOR[.MICRO].[STATUS]
MAJOR.MINOR[.MICRO][STATUS]
The way, setuptools interprets versions is intuitive::
1.0 < 1.1.a1 < 1.1.a2 < 1.1.b < 1.1.dev < 1.1.rc1 < 1.1.rcdev < 1.1 < 1.1.1
1.0 < 1.1dev < 1.1a1 < 1.1a2 < 1.1b < 1.1rc1 < 1.1 < 1.1.1
You can test it with setuptools::
>>> from pkg_resources import parse_version
>>> parse_version('1.0') < parse_version('1.1.dev')
... < parse_version('1.1.a1') < parse_version('1.1.a2')
... < parse_version('1.1.b') < parse_version('1.1.rc1')
... < parse_version('1.1') < parse_version('1.1.1')
Setuptools recommends to seperate parts with a dot. The website about `semantic
versioning <http://semver.org/>`_ is also worth a read.