From 51365bae590d59a82c3cd0cb2c8cfa261e62740c Mon Sep 17 00:00:00 2001
From: Erik Michelson <github@erik.michelson.eu>
Date: Sat, 18 Feb 2023 15:25:44 +0100
Subject: [PATCH] ci(caching): add cleanup workflow

This workflow is recommended by GitHub (docs: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#force-deleting-cache-entries) to remove caches for closed PRs as every PR writes their own cache.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
---
 .github/workflows/cleanup-cache.yml | 33 +++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 .github/workflows/cleanup-cache.yml

diff --git a/.github/workflows/cleanup-cache.yml b/.github/workflows/cleanup-cache.yml
new file mode 100644
index 000000000..3f9d59c76
--- /dev/null
+++ b/.github/workflows/cleanup-cache.yml
@@ -0,0 +1,33 @@
+name: Cleanup caches for closed PRs
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Cleanup
+        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 }}