python venv cache support

h0tw1r3 · h0tw1r3 · commit 528a087a9aab · 2024-04-22T12:22:05.000-05:00
diff --git a/.github/workflows/self-test.yml b/.github/workflows/self-test.yml
@@ -57,6 +57,7 @@ jobs:
         with:
           style: file
           files-changed-only: false
+          cache: true
           # to ignore all build folder contents
           ignore: build|venv
           database: build
diff --git a/action.yml b/action.yml
@@ -55,6 +55,11 @@ inputs:
       [re-running jobs or workflows](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs).
     required: false
     default: info
+  cache:
+    description: |
+      This controls if the python virtual environment is cached.
+    required: false
+    default: false
   lines-changed-only:
     description: |
       This controls what part of the files are analyzed. The following values are accepted:
@@ -234,6 +239,19 @@ runs:
           fi
         fi
 
+    - uses: actions/github-script@v7
+      id: requirements-hash
+      with:
+        script: return require('fs').createReadStream(require('path').join(process.env.GITHUB_ACTION_PATH, 'requirements.txt')).pipe(require('crypto').createHash('sha1').setEncoding('hex'), 'finish').digest('hex')
+        result-encoding: string
+
+    - uses: actions/cache@v4
+      if: ${{ inputs.cache == 'true' }}
+      with:
+        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ steps.requirements-hash.outputs.result }}
+        restore-keys: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-
+        path: ${{ github.action_path }}/venv
+
     - name: Setup python venv (Unix)
       if: runner.os == 'Linux' || runner.os == 'macOS'
       shell: bash
