Improving cache management (#2068)

* Using setup-python cache option.
Setting a workflow for cleaning up cache

* Update .github/workflows/ci.yml

Author: germa89

.github/workflows/cache_cleaner.yml

@@ -0,0 +1,56 @@
+name: cleanup caches by a branch
+on:
+  workflow_dispatch:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Cleanup PR caches
+        if: github.event_name != 'workflow_dispatch'
+        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 && echo "Deleting cache with key: $cacheKey"
+          done
+          echo "Done"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        
+      - name: Cleanup by workflow dispatch
+        if: github.event_name == 'workflow_dispatch'
+        run: |
+            gh extension install actions/gh-actions-cache
+            
+            REPO=${{ github.repository }}
+
+            echo "Fetching list of cache key"
+            cacheKeysForPR=$(gh actions-cache list -R $REPO | 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 && echo "Deleting cache with key: $cacheKey"
+            done
+            echo "Done"
+        env:
+            GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -31,7 +31,6 @@ env:
   # You should go up in number, if you go down (or repeat a previous value)
   # you might end up reusing a previous cache if it haven't been deleted already.
   # It applies 7 days retention policy by default.
-  RESET_PIP_CACHE: 0
   RESET_EXAMPLES_CACHE: 0
   RESET_DOC_BUILD_CACHE: 0
   RESET_AUTOSUMMARY_CACHE: 0
@@ -100,21 +99,14 @@ jobs:
       - name: "Setup Python"
         uses: actions/setup-python@v4
         with:
+          cache: 'pip'
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
       - name: "Install OS packages"
         run: |
           sudo apt update 
           sudo apt install zip pandoc libgl1-mesa-glx xvfb texlive-latex-extra latexmk graphviz
 
-      - name: "Cache pip"
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pip
-          key: Python-v${{ env.RESET_PIP_CACHE }}-Linux-${{ env.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
-          restore-keys: |
-            Python-v${{ env.RESET_PIP_CACHE }}-Linux-${{ env.MAIN_PYTHON_VERSION }}
-
       - name: "Test virtual framebuffer"
         run: |
           pip install -r .ci/requirements_test_xvfb.txt
@@ -288,21 +280,15 @@ jobs:
       - name: "Setup Python"
         uses: actions/setup-python@v4
         with:
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
       - name: "Install os packages"
         run: |
           sudo apt update
           sudo apt install libgl1-mesa-glx xvfb
 
-      - name: "Cache pip"
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pip
-          key: Python-v${{ env.RESET_PIP_CACHE }}-Linux-${{ env.MAIN_PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }}
-          restore-keys: |
-            Python-v${{ env.RESET_PIP_CACHE }}-Linux-${{ env.MAIN_PYTHON_VERSION }}
-
       - name: "Test virtual framebuffer"
         run: |
           pip install -r .ci/requirements_test_xvfb.txt