Add signature and switch to CACHEDIR.TAG

Co-authored-by: Henry Schreiner <[email protected]>

Author: agriyakhetarpal

cibuildwheel/__main__.py

@@ -208,10 +208,8 @@ def main_inner(global_options: GlobalOptions) -> None:
             if not sentinel_file.exists():
                 print(
                     f"Error: {CIBW_CACHE_PATH} does not appear to be a cibuildwheel cache directory.",
-                    file=sys.stderr,
-                )
-                print(
-                    "Only directories with a .cibuildwheel_cached sentinel file can be cleaned.",
+                    "Only directories with a CACHEDIR.TAG sentinel file can be cleaned.",
+                    sep="\n",
                     file=sys.stderr,
                 )
                 sys.exit(1)

cibuildwheel/util/file.py

@@ -29,9 +29,10 @@ def ensure_cache_sentinel(cache_path: Path) -> None:
         cache_path: The cache directory path where the sentinel should be created
     """
     if cache_path.exists():
-        sentinel_file = cache_path / ".cibuildwheel_cached"
+        sentinel_file = cache_path / "CACHEDIR.TAG"
         if not sentinel_file.exists():
-            sentinel_file.write_text("# Created by cibuildwheel automatically\n")
+            sentinel_file.write_text("Signature: 8a477f597d28d172789f06886806bc55\n"
+            "# This file is a cache directory tag created by cibuildwheel.\n")
 
 
 def download(url: str, dest: Path) -> None:

unit_test/main_commands_test.py

@@ -15,8 +15,9 @@ def test_clean_cache_when_cache_exists(tmp_path, monkeypatch, capfd):
     fake_cache_dir.mkdir(parents=True, exist_ok=True)
     assert fake_cache_dir.exists()
 
-    cibw_sentinel = fake_cache_dir / ".cibuildwheel_cached"
-    cibw_sentinel.write_text("# Created by cibuildwheel automatically", encoding="utf-8")
+    cibw_sentinel = fake_cache_dir / "CACHEDIR.TAG"
+    cibw_sentinel.write_text("Signature: 8a477f597d28d172789f06886806bc55\n"
+    "# This file is a cache directory tag created by cibuildwheel.\n", encoding="utf-8")
 
     dummy_file = fake_cache_dir / "dummy.txt"
     dummy_file.write_text("hello")
@@ -56,8 +57,9 @@ def test_clean_cache_with_error(tmp_path, monkeypatch, capfd):
     fake_cache_dir.mkdir(parents=True, exist_ok=True)
     assert fake_cache_dir.exists()
 
-    cibw_sentinel = fake_cache_dir / ".cibuildwheel_cached"
-    cibw_sentinel.write_text("# Created by cibuildwheel automatically\n")
+    cibw_sentinel = fake_cache_dir / "CACHEDIR.TAG"
+    cibw_sentinel.write_text("Signature: 8a477f597d28d172789f06886806bc55\n"
+    "# This file is a cache directory tag created by cibuildwheel.\n")
 
     monkeypatch.setattr(sys, "argv", ["cibuildwheel", "--clean-cache"])