Change fallback version to CANNOT_BUILD_WITHOUT_GIT_DIR

Author: ric-evans

pyproject_toml_builder.py

@@ -26,11 +26,11 @@
 
 from find_packages import iterate_dirnames
 
-BUILDER_SECTION_NAME = "wipac:cicd_setup_builder"
-GENERATED_STR = f"generated by {BUILDER_SECTION_NAME}"
 REAMDE_BADGES_START_DELIMITER = "<!--- Top of README Badges (automated) --->"
 REAMDE_BADGES_END_DELIMITER = "<!--- End of README Badges (automated) --->"
 
+SCM_FALLBACK_VERSION = "CANNOT_BUILD_WITHOUT_GIT_DIR"
+
 LOGGER = logging.getLogger("setup-builder")
 
 TOMLDocumentTypeHint = Any  # TOMLDocument & mypy aren't friendly, so it's either this or a million 'ignore' comments
@@ -498,11 +498,11 @@ def __init__(
             toml_dict["tool"]["setuptools_scm"] = {}
             self._inline_dont_change_this_comment(toml_dict["tool"]["setuptools_scm"])
         # Loud sentinel if SCM/tags are missing
-        toml_dict["tool"]["setuptools_scm"]["fallback_version"] = "UNTAGGED"
+        toml_dict["tool"]["setuptools_scm"]["fallback_version"] = SCM_FALLBACK_VERSION
         comment = (
-            " # only used when SCM metadata is completely unavailable (e.g., no '.git/'). "
-            "NOTE: in shallow clones without git tags, setuptools-scm will still infer a "
-            "commit-based version (like '0.1.dev1+g79c9b4b'); this value will NOT be used in that case."
+            " # used when SCM metadata is missing (no '.git/') — "
+            "if '.git/' exists but does not contain tags, a "
+            "commit-based version (like '0.1.dev1+g79c9b4b') will be used instead."
         )
         toml_dict["tool"]["setuptools_scm"]["fallback_version"].trivia.comment = comment
 

tests/test_pyproject_toml_builder.py

@@ -275,7 +275,7 @@ def test_00_minimum_input(directory: Path, requests_mock: Any) -> None:
             **NO_PYPI_VANILLA_PROJECT_KEYVALS_OUT,  # the true minimum is more vanilla than vanilla)
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {"find": {"exclude": EXCLUDE_DIRS, "namespaces": False}},
@@ -332,7 +332,7 @@ def test_01_minimum_input_w_pypi(directory: Path, requests_mock: Any) -> None:
             **PYPI_URLS_KEYVALS,
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {"find": {"exclude": EXCLUDE_DIRS, "namespaces": False}},
@@ -409,7 +409,7 @@ def test_10_keywords(directory: Path, requests_mock: Any) -> None:
             **PYPI_URLS_KEYVALS,
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {"find": {"exclude": EXCLUDE_DIRS, "namespaces": False}},
@@ -483,7 +483,7 @@ def test_20_python_max(directory: Path, requests_mock: Any) -> None:
             **PYPI_URLS_KEYVALS,
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {"find": {"exclude": EXCLUDE_DIRS, "namespaces": False}},
@@ -557,7 +557,7 @@ def test_30_package_dirs__single(directory: Path, requests_mock: Any) -> None:
             **PYPI_URLS_KEYVALS,
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {
@@ -634,7 +634,7 @@ def test_34_package_dirs__multi_autoname__no_pypi(
             ],
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {
@@ -725,7 +725,7 @@ def test_35_package_dirs__multi(directory: Path, requests_mock: Any) -> None:
             **PYPI_URLS_KEYVALS,
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {
@@ -882,7 +882,7 @@ def test_40_extra_stuff(directory: Path, requests_mock: Any) -> None:
             **PYPI_URLS_KEYVALS,
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {"find": {"exclude": EXCLUDE_DIRS, "namespaces": False}},
@@ -1017,7 +1017,7 @@ def test_80_auto_mypy_option(directory: Path, requests_mock: Any) -> None:
             },
         },
         "tool": {
-            "setuptools_scm": {"fallback_version": "UNTAGGED"},
+            "setuptools_scm": {"fallback_version": "CANNOT_BUILD_WITHOUT_GIT_DIR"},
             "setuptools": {
                 "package-data": {"*": ["py.typed"]},
                 "packages": {"find": {"exclude": EXCLUDE_DIRS, "namespaces": False}},