From a5bb6e0a320bf42f1b219ee2e55ea1c1917961dc Mon Sep 17 00:00:00 2001
From: Richard Si <63936253+ichard26@users.noreply.github.com>
Date: Sat, 28 Aug 2021 15:37:53 -0400
Subject: [PATCH] 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>
---
 CHANGES.md     | 1 +
 pyproject.toml | 5 ++++-
 setup.cfg      | 3 ++-
 3 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index d28d766..6c542f4 100644
--- 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).
+- Pin `setuptools-scm` build-time dependency version (#2457)
 
 ### _Blackd_
 
diff --git a/pyproject.toml b/pyproject.toml
index d085c0d..30e6297 100644
--- 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]
-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]
diff --git a/setup.cfg b/setup.cfg
index 55c66ad..dbd667e 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,2 +1,3 @@
 [options]
-setup_requires = setuptools_scm
+setup_requires =
+  setuptools_scm~=6.0.1
-- 
2.39.2