Merge pull request #1102 from paugier/error-message-env-var

Mention SETUPTOOLS_SCM_PRETEND_VERSION_FOR in error message
pypa · Jan 23, 2025 · 9b6f031 · 9b6f031
2 parents 051ad96 + 2b0722f
commit 9b6f031
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/setuptools_scm/_get_version_impl.py b/src/setuptools_scm/_get_version_impl.py
@@ -122,7 +122,10 @@ def _version_missing(config: Configuration) -> NoReturn:
         "metadata and will not work.\n\n"
         "For example, if you're using pip, instead of "
         "https://github.com/user/proj/archive/master.zip "
-        "use git+https://github.com/user/proj.git#egg=proj"
+        "use git+https://github.com/user/proj.git#egg=proj\n\n"
+        "Alternatively, set the version with the environment variable "
+        "SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME} as described "
+        "in https://setuptools-scm.readthedocs.io/en/latest/config."
     )