chore: rework versioning (#470)

* chore: rework versioning

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

* Update noxfile.py

---------

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

Author: henryiii

README.rst

@@ -70,6 +70,7 @@ The following platforms are supported with binary wheels:
   +---------------+--------------------------+
 
 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

@@ -16,11 +16,15 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import sys
+from pathlib import Path
 
-if sys.version_info < (3, 8):
-    import importlib_metadata as metadata
+if sys.version_info < (3, 11):
+    from tomli import tomllib
 else:
-    from importlib import metadata
+    import tomllib
+
+DIR = Path(__file__).parent.resolve()
+pyproject = DIR.parent / "pyproject.toml"
 
 # -- Options for blockdiag extension --------------------------------------
 
@@ -61,11 +65,11 @@
 # 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 = metadata.version("cmake")
-# The full version, including alpha/beta/rc tags.
-release = version
+with pyproject.open('rb') as f:
+    release = tomllib.load(f)["project"]["version"]
+
+# A shorter version
+version = ".".join(release.split(".")[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/requirements-docs.txt renamed to docs/requirements.txt

@@ -1,9 +1,8 @@
 docutils
 funcparserlib>=1.0.0
 furo
-importlib_metadata; python_version<"3.8"
 pillow<10
 pygments
-scikit-build
 sphinx
 sphinxcontrib-blockdiag # old, not compatible with pillow 10+
+tomli; python_version<"3.11"

noxfile.py

@@ -1,4 +1,5 @@
 import argparse
+import re
 from pathlib import Path
 
 import nox
@@ -57,7 +58,7 @@ def tests(session: nox.Session) -> str:
 @nox.session(reuse_venv=True)
 def docs(session: nox.Session) -> None:
     """
-    Build the docs. Pass "--serve" to serve. Pass "-b linkcheck" to check links.
+    Build the docs. Pass "--non-interactive" to avoid serve. Pass "-- -b linkcheck" to check links.
     """
 
     parser = argparse.ArgumentParser()
@@ -66,16 +67,10 @@ def docs(session: nox.Session) -> None:
         "-b", dest="builder", default="html", help="Build target (default: html)"
     )
     args, posargs = parser.parse_known_args(session.posargs)
+    serve = args.builder == "html" and session.interactive
 
-    if args.builder != "html" and args.serve:
-        session.error("Must not specify non-HTML builder with --serve")
-
-    extra_installs = ["sphinx-autobuild"] if args.serve else []
-
-    wheel = build(session)
-    session.install("-r", "docs/requirements-docs.txt", *extra_installs)
-    session.install(f"./dist/{wheel}")
-
+    extra_installs = ["sphinx-autobuild"] if serve else []
+    session.install("-r", "docs/requirements.txt", *extra_installs)
     session.chdir("docs")
 
     if args.builder == "linkcheck":
@@ -93,12 +88,13 @@ def docs(session: nox.Session) -> None:
         *posargs,
     )
 
-    if args.serve:
-        session.run("sphinx-autobuild", *shared_args)
+    if serve:
+        session.run(
+            "sphinx-autobuild", "--open-browser", "--ignore=.build", *shared_args
+        )
     else:
         session.run("sphinx-build", "--keep-going", *shared_args)
 
-
 def _bump(session: nox.Session, name: str, repository: str, branch: str, script: str, files) -> None:
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -139,6 +135,7 @@ def bump(session: nox.Session) -> None:
     Set to a new version, use -- <version>, otherwise will use the latest version.
     """
     files = (
+        "pyproject.toml",
         "CMakeUrls.cmake",
         "docs/index.rst",
         "README.rst",
@@ -157,3 +154,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, flags=re.MULTILINE))).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,10 +25,6 @@ classifiers = [
     "Topic :: Software Development :: Build Tools",
     "Typing :: Typed"
 ]
-dependencies = [
-  "importlib_metadata>=1.4; python_version<'3.8'",
-]
-dynamic = ["version"]
 requires-python = ">=3.7"
 
 [project.urls]
@@ -52,17 +49,17 @@ 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-*"

scripts/update_cmake_version.py

@@ -175,15 +175,23 @@ def update_docs(version):
 
 
 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, "pyproject.toml"), 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
@@ -216,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 = """\