chore: rework versioning

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.6)
+cmake_minimum_required(VERSION 3.15)
 
 #
 # For more details, see docs/building.rst
@@ -33,7 +33,13 @@ if(CMakePythonDistributions_SUPERBUILD)
 
   option(BUILD_VERBOSE "Build reporting additional information (e.g download progress, ...)" ON)
 
-  option(RUN_CMAKE_TEST "Run CMake test suite when built from sources" ON)
+  if("$env{CIBUILDWHEEL}")
+    set(CIBW ON)
+  else()
+    set(CIBW OFF)
+  endif()
+
+  option(RUN_CMAKE_TEST "Run CMake test suite when built from sources" "${CIBW}")
 
   set(RUN_CMAKE_TEST_EXCLUDE "BootstrapTest" CACHE STRING "CMake test suite exclusion regex")
 

README.rst

@@ -69,7 +69,7 @@ The following platforms are supported with binary wheels:
   | macOS 11+     | Apple Silicon            |
   +---------------+--------------------------+
 
-The last version to provide ``manylinux1`` wheels was ``3.22.x``.
+The last version to provide ``manylinux1`` wheels was ``3.22.x``. The last version to provide Python 2 to Python 3.6 support was ``3.28.x``.
 
 Maintainers
 -----------

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # CMake Python Distributions documentation build configuration file, created by
 # sphinx-quickstart on Wed Nov  9 02:28:46 2016.

noxfile.py

@@ -1,4 +1,5 @@
 import argparse
+import re
 from pathlib import Path
 
 import nox
@@ -157,3 +158,16 @@ def bump_openssl(session: nox.Session) -> None:
         "scripts/manylinux-build-and-install-openssl.sh",
     )
     _bump(session, "OpenSSL", "openssl/openssl", "3.0", "scripts/update_openssl_version.py", files)
+
+
+@nox.session(venv_backend="none")
+def tag_release(session: nox.Session) -> None:
+    """
+    Print instructions for tagging a release and pushing it to GitHub.
+    """
+
+    session.log("Run the following commands to make a release:")
+    txt = Path("pyproject.toml").read_text()
+    current_version = next(iter(re.finditer(r'version = "([\d\.]+)"', txt))).group(1)
+    print(f"git tag --sign -m 'cmake-python-distributions {current_version}' {current_version} main")
+    print(f"git push origin {current_version}")

pyproject.toml

@@ -4,6 +4,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "cmake"
+version = "3.29.0"
 description = "CMake is an open-source, cross-platform family of tools designed to build, test and package software"
 keywords = ["CMake", "build", "c++", "fortran", "cross-platform", "cross-compilation"]
 readme = "README.rst"
@@ -24,7 +25,6 @@ classifiers = [
     "Topic :: Software Development :: Build Tools",
     "Typing :: Typed"
 ]
-dynamic = ["version"]
 requires-python = ">=3.7"
 
 [project.urls]
@@ -50,73 +50,72 @@ ctest = "cmake:ctest"
 [tool.scikit-build]
 minimum-version = "0.8"
 build-dir = "build/{wheel_tag}"
-metadata.version.provider = "scikit_build_core.metadata.setuptools_scm"
 ninja.make-fallback = false
-sdist.include = ["src/cmake/_version.py"]
 wheel.py-api = "py3"
 wheel.expand-macos-universal-tags = true
 wheel.install-dir = "cmake/data"
 
-[tool.setuptools_scm]
-write_to = "src/cmake/_version.py"
-# Setuptools-scm includes type annotations in the default template
-write_to_template = "version = '{version}'"
+[[tool.scikit-build.generate]]
+path = "cmake/_version.py"
+template = '''
+version = "${version}"
+'''
+
 
 [tool.cibuildwheel]
 build = "cp39-*"
 test-extras = "test"
 test-command = "pytest {project}/tests"
 build-verbosity = 1
 
+[tool.cibuildwheel.macos.environment]
+MACOSX_DEPLOYMENT_TARGET = "10.10"
+
 [tool.cibuildwheel.linux]
-before-all = [
-    './scripts/manylinux-build-and-install-openssl.sh',
-]
-environment = { CMAKE_ARGS = "-DOPENSSL_ROOT_DIR:PATH=/usr/local/ssl -DCMAKE_JOB_POOL_COMPILE:STRING=compile -DCMAKE_JOB_POOL_LINK:STRING=link -DCMAKE_JOB_POOLS:STRING=compile=4;link=1 -DCMAKE_CXX_STANDARD:STRING=11" }
+before-all = "./scripts/manylinux-build-and-install-openssl.sh"
 
-[[tool.cibuildwheel.overrides]]
-select = ["*-manylinux_aarch64", "*-manylinux_ppc64le", "*-manylinux_s390x"]
-# disable tests on those platforms, QEMU is taking to long for jobs to pass on GHA
-environment = { CMAKE_ARGS = "-DOPENSSL_ROOT_DIR:PATH=/usr/local/ssl -DCMAKE_JOB_POOL_COMPILE:STRING=compile -DCMAKE_JOB_POOL_LINK:STRING=link -DCMAKE_JOB_POOLS:STRING=compile=4;link=1 -DCMAKE_CXX_STANDARD:STRING=11 -DRUN_CMAKE_TEST:BOOL=OFF" }
+[tool.cibuildwheel.linux.config-settings]
+"cmake.define.OPENSSL_ROOT_DIR" = "/usr/local/ssl"
+"cmake.define.CMAKE_JOB_POOL_COMPILE" = "compile"
+"cmake.define.CMAKE_JOB_POOL_LINK" = "link"
+"cmake.define.CMAKE_JOB_POOLS" = "compile=4;link=1"
 
 [[tool.cibuildwheel.overrides]]
-select = ["*-musllinux_x86_64", "*-musllinux_i686"]
+select = ["*-musllinux_*",]
+inherit.config-settings = "append"
 # disable some tests
 # - BootstrapTest fails with custom OpenSSL and probably does not make much sense for this project
 # - ExportImport|RunCMake.install|RunCMake.file-GET_RUNTIME_DEPENDENCIES: c.f. https://discourse.cmake.org/t/cmake-test-suite-failing-on-alpine-linux/5064
-environment = { CMAKE_ARGS = "-DOPENSSL_ROOT_DIR:PATH=/usr/local/ssl -DCMAKE_JOB_POOL_COMPILE:STRING=compile -DCMAKE_JOB_POOL_LINK:STRING=link -DCMAKE_JOB_POOLS:STRING=compile=4;link=1 -DRUN_CMAKE_TEST_EXCLUDE:STRING='BootstrapTest|ExportImport|RunCMake.install|RunCMake.RuntimePath|RunCMake.file-GET_RUNTIME_DEPENDENCIES'" }
+config-settings."cmake.define.RUN_CMAKE_TEST_EXCLUDE" = "BootstrapTest|ExportImport|RunCMake.install|RunCMake.RuntimePath|RunCMake.file-GET_RUNTIME_DEPENDENCIES"
 
 [[tool.cibuildwheel.overrides]]
-select = ["*-musllinux_aarch64", "*-musllinux_ppc64le", "*-musllinux_s390x"]
+select = ["*linux_aarch64", "*linux_ppc64le", "*linux_s390x"]
+inherit.config-settings = "append"
 # disable tests on those platforms, QEMU is taking to long for jobs to pass on GHA
-environment = { CMAKE_ARGS = "-DOPENSSL_ROOT_DIR:PATH=/usr/local/ssl -DCMAKE_JOB_POOL_COMPILE:STRING=compile -DCMAKE_JOB_POOL_LINK:STRING=link -DCMAKE_JOB_POOLS:STRING=compile=4;link=1 -DRUN_CMAKE_TEST:BOOL=OFF" }
-
-[tool.cibuildwheel.macos.environment]
-MACOSX_DEPLOYMENT_TARGET = "10.10"
+config-settings."cmake.define.RUN_CMAKE_TEST" = "OFF"
 
 
 [tool.ruff]
 src = ["src"]
 
 [tool.ruff.lint]
 extend-select = [
-  "B",           # flake8-bugbear
-  "I",           # isort
   "ARG",         # flake8-unused-arguments
+  "B",           # flake8-bugbear
   "C4",          # flake8-comprehensions
+  "EXE",         # flake8-executable
+  "G",           # flake8-logging-format
+  "I",           # isort
   "ICN",         # flake8-import-conventions
   "ISC",         # flake8-implicit-str-concat
-  "G",           # flake8-logging-format
   "PGH",         # pygrep-hooks
   "PIE",         # flake8-pie
   "PL",          # pylint
   "PT",          # flake8-pytest-style
   "RET",         # flake8-return
   "RUF",         # Ruff-specific
   "SIM",         # flake8-simplify
-  "EXE",         # flake8-executable
-  "NPY",         # NumPy specific rules
-  "PD",          # pandas-vet
+  "UP",          # pyupgrade
 ]
 ignore = [
   "PLR09",  # Too many X

scripts/update_cmake_version.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 """
 Command line executable allowing to update CMakeUrls.cmake given a CMake
 version.
@@ -68,9 +67,7 @@ def get_cmake_archive_urls_and_sha256s(version, verbose=False):
                         sha256 = line.split()[0].strip()
                         identifier = expected_files[file]
                         shas[identifier] = sha256
-        assert len(shas) == len(expected_files), "{} != {}".format(
-            len(shas), len(expected_files)
-        )
+        assert len(shas) == len(expected_files), f"{len(shas)} != {len(expected_files)}"
 
         # Get download URLs for each asset
         urls = {}
@@ -86,19 +83,19 @@ def get_cmake_archive_urls_and_sha256s(version, verbose=False):
             for identifier in set(expected_files.values()) - set(urls.keys()):
                 missing_files.append(expected_files_by_identifier[identifier])
             raise RuntimeError(
-                "Couldn't find {} at {}".format(missing_files, files_base_url)
+                f"Couldn't find {missing_files} at {files_base_url}"
             )
 
         # combine the URLs and SHA256s into a single dictionary
         zipped = {}
         for value in expected_files.values():
-            print("[{}]\n{}\n{}\n".format(value, urls[value], shas[value]))
+            print(f"[{value}]\n{urls[value]}\n{shas[value]}\n")
             zipped[value] = (urls[value], shas[value])
         assert len(zipped) == len(expected_files)
 
         if verbose:
             for identifier, (url, sha256) in zipped.items():
-                print("[{}]\n{}\n{}\n".format(identifier, url, sha256))
+                print(f"[{identifier}]\n{url}\n{sha256}\n")
 
         return zipped
 
@@ -150,7 +147,7 @@ def update_cmake_urls_script(version):
     cmake_urls_filename = "CMakeUrls.cmake"
     cmake_urls_filepath = os.path.join(ROOT_DIR, cmake_urls_filename)
 
-    msg = "Updating '{}' with CMake version {}".format(cmake_urls_filename, version)
+    msg = f"Updating '{cmake_urls_filename}' with CMake version {version}"
     with _log(msg), open(cmake_urls_filepath, "w") as cmake_file:
         cmake_file.write(content)
 
@@ -159,7 +156,7 @@ def _update_file(filepath, regex, replacement):
     msg = "Updating %s" % os.path.relpath(filepath, ROOT_DIR)
     with _log(msg):
         pattern = re.compile(regex)
-        with open(filepath, "r") as doc_file:
+        with open(filepath) as doc_file:
             lines = doc_file.readlines()
             updated_content = []
             for line in lines:
@@ -172,24 +169,29 @@ def update_docs(version):
     pattern = re.compile(
         r"CMake \d.(\d)+.\d <https://cmake.org/cmake/help/v\d.(\d)+/index.html>"
     )
-    replacement = "CMake {} <https://cmake.org/cmake/help/v{}/index.html>".format(
-        version,
-        _major_minor(version),
-    )
+    replacement = f"CMake {version} <https://cmake.org/cmake/help/v{_major_minor(version)}/index.html>"
     for filename in ["docs/index.rst", "README.rst"]:
         _update_file(os.path.join(ROOT_DIR, filename), pattern, replacement)
 
 
 def update_tests(version):
-    pattern = re.compile(r'expected_version = "\d.(\d)+.\d"')
+    pattern = re.compile(r'expected_version = "\d.\d+.\d"')
     replacement = 'expected_version = "%s"' % version
     _update_file(
         os.path.join(ROOT_DIR, "tests/test_cmake.py"), pattern, replacement
     )
 
 
+def update_pyproject_toml(version):
+    pattern = re.compile(r'version = "[\w\.]+"')
+    replacement = 'version = "%s"' % version
+    _update_file(
+        os.path.join(ROOT_DIR, "tests/test_cmake.py"), pattern, replacement
+    )
+
+
 def update_raw_versions(version):
-    pattern = re.compile(r"\d\.(\d)+\.\d")
+    pattern = re.compile(r"\d\.\d+\.\d")
     replacement = version
     _update_file(
         os.path.join(ROOT_DIR, "docs/update_cmake_version.rst"), pattern, replacement
@@ -222,6 +224,7 @@ def main():
         update_docs(args.cmake_version)
         update_tests(args.cmake_version)
         update_raw_versions(args.cmake_version)
+        update_pyproject_toml(args.cmake_version)
 
         if not args.quiet:
             msg = """\

scripts/update_openssl_version.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 """
 Command line executable allowing to update OpenSSL version.
 """
@@ -37,15 +36,15 @@ def get_openssl_sha256(version, verbose=False):
     with _log("Collecting SHA256 from '%s'" % files_base_url):
         sha256 = requests.get(files_base_url).content.decode("ascii").strip()
         if verbose:
-            print("got sha256: {}".format(sha256))
+            print(f"got sha256: {sha256}")
         return sha256
 
 
 def _update_file(filepath, regex, replacement):
     msg = "Updating %s" % os.path.relpath(filepath, ROOT_DIR)
     with _log(msg):
         pattern = re.compile(regex)
-        with open(filepath, "r") as doc_file:
+        with open(filepath) as doc_file:
             lines = doc_file.readlines()
             updated_content = []
             for line in lines:

tests/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import sys
 from contextlib import contextmanager
 

tests/test_cmake.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import os
 import subprocess
 import sys
@@ -61,11 +60,7 @@ def _get_scripts():
     scripts = []
     for file in dist.files:
         if os.path.abspath(str(file.locate().parent)) in scripts_paths:
-            if sys.version_info < (3, 6):
-                # pre-3.6 behavior is strict
-                scripts.append(file.locate().resolve())
-            else:
-                scripts.append(file.locate().resolve(strict=True))
+            scripts.append(file.locate().resolve(strict=True))
     return scripts
 
 
@@ -75,4 +70,4 @@ def test_cmake_script(tool):
     scripts = [script for script in _get_scripts() if script.stem == tool]
     assert len(scripts) == 1
     output = subprocess.check_output([str(scripts[0]), "--version"]).decode("ascii")
-    assert output.splitlines()[0] == "{} version {}".format(tool, expected_version)
+    assert output.splitlines()[0] == f"{tool} version {expected_version}"