Merge ce207c8817 into b7e8d49f17

Using the cache is only effective when not using install as it will run
`pipenv --rm` if it detects an old environment. On top of that, pip is a
lot faster at detecting satisfied requirements.

.github/workflows/codeql.yml

@@ -20,7 +20,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v4
+      uses: github/codeql-action/init@v3
       # Override language selection by uncommenting this and choosing your languages
       # with:
       #   languages: go, javascript, csharp, python, cpp, java, ruby
@@ -28,7 +28,7 @@ jobs:
     # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below).
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v4
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -42,4 +42,4 @@ jobs:
     #     make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v4
+      uses: github/codeql-action/analyze@v3

examples.md

@@ -49,7 +49,7 @@
   with:
     path: |
       ~/.bun/install/cache
-    key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
+    key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
 ```
 
 ### Windows
@@ -59,7 +59,7 @@
   with:
     path: |
       ~\.bun
-    key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
+    key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
 ```
 
 ## C# - NuGet
@@ -563,6 +563,15 @@ jobs:
     key: ${{ runner.os }}-python-${{ steps.setup-python.outputs.python-version }}-pipenv-${{ hashFiles('Pipfile.lock') }}
 ```
 
+To use the cache effectively:
+```yaml
+- name: Install packages
+  run: |
+    pipenv --venv && \
+      (pipenv lock -r |cat - ci-requirements.txt|pipenv run pip install -r /dev/stdin) || \
+      (pipenv install --python ${{ matrix.python-version }} --deploy)
+```
+
 ## R - renv
 
 For renv, the cache directory will vary by OS. The `RENV_PATHS_ROOT` environment variable is used to set the cache location. Have a look at https://rstudio.github.io/renv/reference/paths.html#details for more details.