From 93a2ef8f80b3752c3089ca4ad6300ae519897d12 Mon Sep 17 00:00:00 2001
From: sj <suresh@vicarasolutions.com>
Date: Tue, 18 Jun 2024 13:16:42 -0400
Subject: [PATCH] Fixed macro comments

---
 README.md               |  2 --
 pants-plugins/macros.py | 28 ++++++++++++++++++----------
 2 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index e789601..974562f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
 # Dockerfiles
 
-## Cache Strategy
-
 ## Deprecations/Removals
 
 ### TI-specific toolchains
diff --git a/pants-plugins/macros.py b/pants-plugins/macros.py
index c7ad06e..36bda0e 100644
--- a/pants-plugins/macros.py
+++ b/pants-plugins/macros.py
@@ -1,6 +1,8 @@
 def default_ghcr_cache(target_name: str) -> tuple[str, Optional[str]]:  # noqa: F821
     """
-    From Github Actions default env vars, try to constitute
+    Using Github Actions default env vars - create a cache_from, and cache_to taking
+    into account branches and PRs for better cache locality.
+
     https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
     """
     # Need to specify this, because Pants doesn't reconcile `@ghcr` in the cache details
@@ -36,17 +38,23 @@ def default_ghcr_cache(target_name: str) -> tuple[str, Optional[str]]:  # noqa:
 
 def docker_image_gha(name: str, **kwargs) -> None:
     """
-    A macro to create a Docker image that caches to Github Actions, by default.
+    A macro to create a Docker image that caches to Github Actions cache, by default.
     """
-    # cache_from = kwargs.pop("cache_from", {"type": "gha", "scope": name})
-    # cache_to = kwargs.pop("cache_to", {"type": "gha", "mode": "max", "scope": name})
+    cache_from = kwargs.pop("cache_from", {"type": "gha", "scope": name})
+    cache_to = kwargs.pop("cache_to", {"type": "gha", "mode": "max", "scope": name})
+
+    docker_image(  # noqa: F821
+        name=name,
+        cache_from=cache_from,
+        cache_to=cache_to,
+        **kwargs,
+    )
+
 
-    # docker_image(  # noqa: F821
-    #     name=name,
-    #     cache_from=cache_from,
-    #     cache_to=cache_to,
-    #     **kwargs,
-    # )
+def docker_image_ghcr(name: str, **kwargs) -> None:
+    """
+    A macro to create a Docker image that caches to Github Container Registry, by default.
+    """
 
     cache_from, cache_to = default_ghcr_cache(name)
     cache_from = kwargs.pop(