From 554a3464a70ff39ab3480b9341b31ee7f2520b85 Mon Sep 17 00:00:00 2001
From: Erik Burton <erikburt@users.noreply.github.com>
Date: Thu, 7 Nov 2024 13:19:31 -0800
Subject: [PATCH] feat: force delete branch caches on PR close (#15159)

---
 .github/workflows/delete-caches.yml | 42 +++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 .github/workflows/delete-caches.yml

diff --git a/.github/workflows/delete-caches.yml b/.github/workflows/delete-caches.yml
new file mode 100644
index 00000000000..870b6b6d086
--- /dev/null
+++ b/.github/workflows/delete-caches.yml
@@ -0,0 +1,42 @@
+name: Cleanup Caches
+
+# See: 
+# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows#force-deleting-cache-entries
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  cleanup-branch-caches:
+    runs-on: ubuntu-latest
+    permissions:
+      # `actions:write` permission is required to delete caches
+      #   See also: https://docs.github.com/en/rest/actions/cache?apiVersion=2022-11-28#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
+      actions: write
+      contents: read
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4.1.2
+
+      - name: Cleanup Branch Caches
+        run: |
+          gh extension install actions/gh-actions-cache
+          
+          REPO=${{ github.repository }}
+          BRANCH=refs/pull/${{ github.event.pull_request.number }}/merge
+
+          echo "Fetching list of cache key"
+          cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
+
+          ## Setting this to not fail the workflow while deleting cache keys. 
+          set +e
+          echo "Deleting caches..."
+          for cacheKey in $cacheKeysForPR
+          do
+              gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
+          done
+          echo "Done"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
\ No newline at end of file