reduce hard-coding of version (#135)

CMakeLists.txt

@@ -1,6 +1,18 @@
 cmake_minimum_required(VERSION 3.24.0 FATAL_ERROR)
 
-project(legateboost VERSION 1.0 LANGUAGES C CXX CUDA)
+# read project version from VERSION file
+file(READ "${CMAKE_CURRENT_LIST_DIR}/VERSION" _version_content)
+if(_version_content MATCHES [[^([0-9]+)\.([0-9]+)\.([0-9]+)]])
+  set(_legateboost_version "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}")
+else()
+  string(REPLACE "\n" "\n  " _legateboost_content_formatted "  ${_version_content}")
+  message(
+    FATAL_ERROR
+      "Could not determine project version. Contents of VERSION file:\n${_legateboost_content_formatted}"
+  )
+endif()
+
+project(legateboost VERSION "${_legateboost_version}" LANGUAGES C CXX CUDA)
 
 option(SANITIZE "Build with address sanitizer" OFF)
 

MANIFEST.in

@@ -0,0 +1 @@
+include legateboost/VERSION

VERSION

@@ -0,0 +1 @@
+0.1.0

contributing.md

@@ -73,6 +73,12 @@ Run all checks manually.
 ```
 pre-commit run --all-files
 ```
+
+## Change the project version
+
+The `VERSION` file at the root of the repo is the single source for `legate-boost`'s version.
+Modify that file to change the version for wheels, conda packages, the CMake project, etc.
+
 ## Development principles
 
 The following general principles should be followed when developing `legate-boost`.

docs/source/conf.py

@@ -3,11 +3,15 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+from datetime import datetime
+
+import legateboost
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "legate-boost"
-copyright = "2023, NVIDIA"
+copyright = f"2023-{datetime.today().year}, NVIDIA"
 author = "NVIDIA"
 
 # -- General configuration ---------------------------------------------------
@@ -27,6 +31,16 @@
 
 source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
 
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+
+# The short X.Y version.
+version = legateboost.__version__
+
+# The full version, including alpha/beta/rc tags.
+release = version
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

legateboost/VERSION

@@ -0,0 +1 @@
+../VERSION

legateboost/__init__.py

@@ -25,3 +25,4 @@
     EarlyStopping,
 )
 from .utils import mod_col_by_idx, pick_col_by_idx, set_col_by_idx
+from ._version import __version__

legateboost/_version.py

@@ -0,0 +1,7 @@
+import importlib.resources
+
+__version__ = (
+    importlib.resources.files(__package__).joinpath("VERSION").read_text().strip()
+)
+
+__all__ = ["__version__"]

legateboost/test/test_version.py

@@ -0,0 +1,7 @@
+import legateboost
+
+
+def test_version_constants_are_populated():
+    # __version__ should always be non-empty
+    assert isinstance(legateboost.__version__, str)
+    assert len(legateboost.__version__) > 0

pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "legate-boost"
-version = "0.1"
+dynamic = ["version"]
 authors = [
     {name = "NVIDIA Corporation"},
 ]
@@ -45,6 +45,9 @@ test = [
     "xgboost",
 ] # This list was generated by `rapids-dependency-file-generator`. To make changes, edit dependencies.yaml and run `rapids-dependency-file-generator`.
 
+[tool.setuptools.dynamic]
+version = {file = "legateboost/VERSION"}
+
 [tool.mypy]
 
 disallow_untyped_defs = true