nominatim/version.py

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2022 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Version information for Nominatim.
   9 """
  10
  11 # Version information: major, minor, patch level, database patch level
  12 #
  13 # The first three numbers refer to the last released version.
  14 #
  15 # The database patch level tracks important changes between releases
  16 # and must always be increased when there is a change to the database or code
  17 # that requires a migration.
  18 #
  19 # When adding a migration on the development branch, raise the patch level
  20 # to 99 to make sure that the migration is applied when updating from a
  21 # patch release to the next minor version. Patch releases usually shouldn't
  22 # have migrations in them. When they are needed, then make sure that the
  23 # migration can be reapplied and set the migration version to the appropriate
  24 # patch level when cherry-picking the commit with the migration.
  25 #
  26 # Released versions always have a database patch level of 0.
  27 NOMINATIM_VERSION = (4, 0, 99, 6)
  28
  29 POSTGRESQL_REQUIRED_VERSION = (9, 5)
  30 POSTGIS_REQUIRED_VERSION = (2, 2)
  31
  32 # Cmake sets a variabe @GIT_HASH@ by executing 'git --log'. It is not run
  33 # on every execution of 'make'.
  34 # cmake/tool-installed.tmpl is used to build the binary 'nominatim'. Inside
  35 # there is a call to set the variable value below.
  36 GIT_COMMIT_HASH = None
  37
  38
  39 # pylint: disable=consider-using-f-string
  40 def version_str(version=NOMINATIM_VERSION):
  41     """
  42     Return a human-readable string of the version.
  43     """
  44     return '{}.{}.{}-{}'.format(*version)