fixes #8133: mitigate regendoc issues wrt PRETEND_VERSION

this issues is less likely to hit due to the recent regendoc release
which includes a wheel

* migrate to setuptools_scm 6.3.2
* use SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST

.github/workflows/main.yml

@@ -222,7 +222,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install --upgrade wheel setuptools tox
+        pip install --upgrade wheel setuptools setuptools_scm[toml]>=6 tox
 
     - name: Build package
       run: |

changelog/8133.trivial.rst

@@ -0,0 +1 @@
+Migrate to setuptools_scm 6.x to use SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST for more robust release tooling.

pyproject.toml

@@ -1,8 +1,8 @@
 [build-system]
 requires = [
   # sync with setup.py until we discard non-pep-517/518
-  "setuptools>=42.0",
+  "setuptools>=45.0",
-  "setuptools-scm[toml]>=3.4",
+  "setuptools-scm[toml]>=6.2.3",
   "wheel",
 ]
 build-backend = "setuptools.build_meta"

scripts/release.py

@@ -63,7 +63,7 @@ def regen(version):
     print(f"{Fore.CYAN}[generate.regen] {Fore.RESET}Updating docs")
     check_call(
         ["tox", "-e", "regen"],
-        env={**os.environ, "SETUPTOOLS_SCM_PRETEND_VERSION": version},
+        env={**os.environ, "SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST": version},
     )
 
 

setup.cfg

@@ -55,8 +55,8 @@ python_requires = >=3.6
 package_dir =
     =src
 setup_requires =
-    setuptools>=42.0
+    setuptools
-    setuptools-scm>=3.4
+    setuptools-scm>=6.0
 zip_safe = no
 
 [options.entry_points]

tox.ini

@@ -17,13 +17,15 @@ envlist =
     docs
     docs-checklinks
 
+
+
 [testenv]
 commands =
     {env:_PYTEST_TOX_COVERAGE_RUN:} pytest {posargs:{env:_PYTEST_TOX_DEFAULT_POSARGS:}}
     doctesting: {env:_PYTEST_TOX_COVERAGE_RUN:} pytest --doctest-modules --pyargs _pytest
     coverage: coverage combine
     coverage: coverage report -m
-passenv = USER USERNAME COVERAGE_* PYTEST_ADDOPTS TERM
+passenv = USER USERNAME COVERAGE_* PYTEST_ADDOPTS TERM SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST
 setenv =
     _PYTEST_TOX_DEFAULT_POSARGS={env:_PYTEST_TOX_POSARGS_DOCTESTING:} {env:_PYTEST_TOX_POSARGS_LSOF:} {env:_PYTEST_TOX_POSARGS_XDIST:}
 
@@ -83,10 +85,7 @@ commands =
 [testenv:regen]
 changedir = doc/en
 basepython = python3
-passenv = SETUPTOOLS_SCM_PRETEND_VERSION
+passenv = SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST
-# TODO: When setuptools-scm 5.0.0 is released, use SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST
-# and remove the next line.
-install_command=python -m pip --use-deprecated=legacy-resolver install {opts} {packages}
 deps =
     dataclasses
     PyYAML
@@ -112,8 +111,6 @@ changedir = testing/plugins_integration
 deps = -rtesting/plugins_integration/requirements.txt
 setenv =
     PYTHONPATH=.
-    # due to pytest-rerunfailures requiring 6.2+; can be removed after 6.2.0
-    SETUPTOOLS_SCM_PRETEND_VERSION=6.2.0a1
 commands =
     pip check
     pytest bdd_wallet.py
@@ -180,6 +177,7 @@ extend-ignore =
     ; Docstring Content Issues
     D400,D401,D401,D402,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414,D415,D416,D417
 
+
 [isort]
 ; This config mimics what reorder-python-imports does.
 force_single_line = 1