Update versioning strategy (#548)

See rapidsai/rmm#1347

Authors:
  - Vyas Ramasubramani (https://github.com/vyasr)

Approvers:
  - AJ Schmidt (https://github.com/ajschmidt8)
  - Ajay Thorve (https://github.com/AjayThorve)

URL: #548

VERSION

@@ -0,0 +1 @@
+23.12.00

ci/build_python.sh

@@ -7,11 +7,20 @@ source rapids-env-update
 
 rapids-print-env
 
+package_name="cuxfilter"
+package_dir="python"
+
+version=$(rapids-generate-version)
+commit=$(git rev-parse HEAD)
+
+echo "${version}" > VERSION
+sed -i "/^__git_commit__/ s/= .*/= \"${commit}\"/g" "${package_dir}/${package_name}/_version.py"
+
 rapids-logger "Begin py build"
 
 # TODO: Remove `--no-test` flag once importing on a CPU
 # node works correctly
-rapids-conda-retry mambabuild \
+RAPIDS_PACKAGE_VERSION=${version} rapids-conda-retry mambabuild \
   --no-test \
   conda/recipes/cuxfilter
 

ci/build_wheel.sh

@@ -9,9 +9,8 @@ package_dir="python"
 source rapids-configure-sccache
 source rapids-date-string
 
-# Use gha-tools rapids-pip-wheel-version to generate wheel version then
-# update the necessary files
-version_override="$(rapids-pip-wheel-version ${RAPIDS_DATE_STRING})"
+version=$(rapids-generate-version)
+commit=$(git rev-parse HEAD)
 
 RAPIDS_PY_CUDA_SUFFIX="$(rapids-wheel-ctk-name-gen ${RAPIDS_CUDA_VERSION})"
 
@@ -21,9 +20,11 @@ PACKAGE_CUDA_SUFFIX="-${RAPIDS_PY_CUDA_SUFFIX}"
 
 # Patch project metadata files to include the CUDA version suffix and version override.
 pyproject_file="${package_dir}/pyproject.toml"
+version_file="${package_dir}/${package_name}/_version.py"
 
-sed -i "s/^version = .*/version = \"${version_override}\"/g" ${pyproject_file}
 sed -i "s/name = \"${package_name}\"/name = \"${package_name}${PACKAGE_CUDA_SUFFIX}\"/g" ${pyproject_file}
+echo "${version}" > VERSION
+sed -i "/^__git_commit__/ s/= .*/= \"${commit}\"/g" ${version_file}
 
 # For nightlies we want to ensure that we're pulling in alphas as well. The
 # easiest way to do so is to augment the spec with a constraint containing a

ci/release/update-version.sh

@@ -39,8 +39,9 @@ sed_runner 's/release = .*/release = '"'${NEXT_FULL_TAG}'"'/g' docs/source/conf.
 # docs update
 sed_runner "/cuxfilter=[0-9]\{2\}.[0-9]\{2\}/ s/=[0-9]\{2\}.[0-9]\{2\}/=${NEXT_SHORT_TAG}/g" docs/source/user_guide/installation.rst
 
-# Python __init__.py updates
-sed_runner "s/__version__ = .*/__version__ = \"${NEXT_FULL_TAG}\"/g" python/cuxfilter/__init__.py
+# Centralized version file update
+echo "${NEXT_FULL_TAG}" > VERSION
+
 
 DEPENDENCIES=(
   cudf

conda/recipes/cuxfilter/meta.yaml

@@ -1,6 +1,6 @@
 # Copyright (c) 2018-2023, NVIDIA CORPORATION.
 
-{% set version = environ.get('GIT_DESCRIBE_TAG', '0.0.0.dev').lstrip('v') %}
+{% set version = environ['RAPIDS_PACKAGE_VERSION'].lstrip('v') %}
 {% set minor_version = version.split('.')[0] + '.' + version.split('.')[1] %}
 {% set cuda_version = '.'.join(environ['RAPIDS_CUDA_VERSION'].split('.')[:2]) %}
 {% set cuda_major = cuda_version.split('.')[0] %}
@@ -12,7 +12,7 @@ package:
   version: {{ version }}
 
 source:
-  git_url: ../../..
+  path: ../../..
 
 build:
   number: {{ GIT_DESCRIBE_NUMBER }}

python/cuxfilter/VERSION

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

python/cuxfilter/__init__.py

@@ -2,5 +2,4 @@
 
 from cuxfilter.dataframe import DataFrame
 from cuxfilter.dashboard import DashBoard
-
-__version__ = "23.12.00"
+from cuxfilter._version import __git_commit__, __version__

python/cuxfilter/_version.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2023, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import importlib.resources
+
+__version__ = (
+    importlib.resources.files("cuxfilter")
+    .joinpath("VERSION")
+    .read_text()
+    .strip()
+)
+__git_commit__ = ""

python/pyproject.toml

@@ -9,7 +9,7 @@ requires = [
 
 [project]
 name = "cuxfilter"
-version = "23.8"
+dynamic = ["version"]
 description = "GPU accelerated cross filtering with cuDF"
 readme = { file = "README.md", content-type = "text/markdown" }
 authors = [
@@ -56,3 +56,6 @@ Documentation = "https://docs.rapids.ai/api/cuxfilter/stable/"
 
 [tool.setuptools]
 license-files = ["LICENSE"]
+
+[tool.setuptools.dynamic]
+version = {file = "cuxfilter/VERSION"}

python/setup.py

@@ -2,10 +2,13 @@
 
 from setuptools import find_packages, setup
 
+packages = find_packages(
+    include=["cuxfilter", "cuxfilter.*"],
+    exclude=("tests", "docs", "notebooks"),
+)
+
 setup(
-    packages=find_packages(
-        include=["cuxfilter", "cuxfilter.*"],
-        exclude=("tests", "docs", "notebooks"),
-    ),
+    packages=packages,
+    package_data={key: ["VERSION"] for key in packages},
     zip_safe=False,
 )