add documentation for postcode customization

[nominatim.git] / nominatim / version.py

diff --git a/nominatim/version.py b/nominatim/version.py
index 8d1c6849cf80a4fb334a9096414b2b934c197722..88d42af923f01e6bd812fa5b842a7b7988616551 100644 (file)
--- a/nominatim/version.py
+++ b/nominatim/version.py
@@ -1,8 +1,44 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2022 by the Nominatim developer community.
+# For a full list of authors see the git log.

 """
 Version information for Nominatim.
 """
 
 """
 Version information for Nominatim.
 """
 

-NOMINATIM_VERSION = "3.6.0"
+# Version information: major, minor, patch level, database patch level
+#
+# The first three numbers refer to the last released version.
+#
+# The database patch level tracks important changes between releases
+# and must always be increased when there is a change to the database or code
+# that requires a migration.
+#
+# When adding a migration on the development branch, raise the patch level
+# to 99 to make sure that the migration is applied when updating from a
+# patch release to the next minor version. Patch releases usually shouldn't
+# have migrations in them. When they are needed, then make sure that the
+# migration can be reapplied and set the migration version to the appropriate
+# patch level when cherry-picking the commit with the migration.
+#
+# Released versions always have a database patch level of 0.
+NOMINATIM_VERSION = (4, 0, 99, 6)

 
 

-POSTGRESQL_REQUIRED_VERSION = (9, 3)
+POSTGRESQL_REQUIRED_VERSION = (9, 5)

 POSTGIS_REQUIRED_VERSION = (2, 2)
 POSTGIS_REQUIRED_VERSION = (2, 2)

+
+# Cmake sets a variabe @GIT_HASH@ by executing 'git --log'. It is not run
+# on every execution of 'make'.
+# cmake/tool-installed.tmpl is used to build the binary 'nominatim'. Inside
+# there is a call to set the variable value below.
+GIT_COMMIT_HASH = None
+
+
+# pylint: disable=consider-using-f-string
+def version_str(version=NOMINATIM_VERSION):
+    """
+    Return a human-readable string of the version.
+    """
+    return '{}.{}.{}-{}'.format(*version)