Pin setuptools-scm build time dependency (#2457)

The setuptools-scm dependency in setup.cfg did not have a version
specified, leading to the issues described in #2449 after a faulty release
of setuptools-scm was published. To avoid this issue in the future, the
last version before that faulty update is now pinned.

Commit history before merge:

* Pin setuptools-scm dependency version (#2449)
* Update CHANGES.md
* Let's pin in pyproject.toml too

Mostly since it's non-build-backend specific configuration and more
widely standardized file. Not sure what benefits pinning in setup.cfg
gives us on top of pyproject.toml but I'd rather not find out during
the release that is supposed to happen today :wink:

Co-authored-by: FiNs <24248249+FabianNiehaus@users.noreply.github.com>

diff --git a/CHANGES.md b/CHANGES.md
index d28d766f4c0d868eb5c3610e2a1d3d2434580b4b..6c542f446e79da20e91999595a3fbb11c96c5b07 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -13,6 +13,7 @@
   trailing comma (#2384)
 - Parsing support has been added for unparenthesized walruses in set literals, set
   comprehensions, and indices (#2447).
   trailing comma (#2384)
 - Parsing support has been added for unparenthesized walruses in set literals, set
   comprehensions, and indices (#2447).

+- Pin `setuptools-scm` build-time dependency version (#2457)

 
 ### _Blackd_
 
 
 ### _Blackd_
 

diff --git a/pyproject.toml b/pyproject.toml
index d085c0ddc62bd4e985d3468c07ea3f92a781b859..30e6297447555359dddb58d038fd8a0ccf30493b 100644 (file)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -23,7 +23,10 @@ extend-exclude = '''
 # NOTE: You don't need this in your own Black configuration.
 
 [build-system]
 # NOTE: You don't need this in your own Black configuration.
 
 [build-system]

-requires = ["setuptools>=41.0", "setuptools-scm", "wheel"]
+# We're pinning setuptools-scm to bugfix versions only because for build-time
+# deps having them work on install by default is really important. Especially
+# since it's hard for users to work-around the specified build requirements.
+requires = ["setuptools>=41.0", "setuptools_scm~=6.0.1", "wheel"]

 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]

diff --git a/setup.cfg b/setup.cfg
index 55c66add7fb7d955944824ad237b6af0037f9f69..dbd667e8f19fc6409844428a896270f763a48f65 100644 (file)
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,2 +1,3 @@
 [options]
 [options]

-setup_requires = setuptools_scm
+setup_requires =
+  setuptools_scm~=6.0.1