version bump to 0.9.0a1, plus developers' notes on versioning (#122)

MetOffice · Jul 4, 2022 · f35338c · f35338c
1 parent 6a92bcf
commit f35338c
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,7 +22,7 @@
 author = 'Fab Team'
 
 # The full version, including alpha/beta/rc tags
-release = '2022.1.dev0'
+release = '0.9.0a1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/development.rst b/docs/source/development.rst
@@ -0,0 +1,27 @@
+
+Development
+===========
+Information for developers.
+
+Version numbering
+-----------------
+We use a `PEP 440 compliant <https://peps.python.org/pep-0440/#examples-of-compliant-version-schemes>`_
+semantic versioning, of the form ``{major}.{minor}.{patch}[{a|b|rc}N]``
+
+* 0.9.5
+* 1.0.0a1
+* 1.0.0a2
+* 1.0.0b1
+* 1.0.0rc1
+* 1.0.0
+* 1.0.1
+* 1.1.0a1
+
+Version bumping
+---------------
+The version number needs to be updated in two places
+
+* source/fab/__init_.py
+* docs/source/conf.py
+
+Consider adding a developers' tool like `BumpVer <https://pypi.org/project/bumpver>`_.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -28,4 +28,5 @@ Contents
    overview
    usage
    Api Reference <apidoc/modules>
+   development
    glossary
diff --git a/source/fab/__init__.py b/source/fab/__init__.py
@@ -10,7 +10,7 @@
 import logging
 import sys
 
-__version__ = '2022.1.dev0'
+__version__ = '0.9.0a1'
 
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.StreamHandler(sys.stdout))