Default to enable-cache: true on GitHub hosted runners (#193)

Closes: #54
astral-sh · Dec 13, 2024 · e3017a7 · e3017a7
1 parent 3460fe1
commit e3017a7
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 10 deletions.
diff --git a/.github/workflows/test-cache.yml b/.github/workflows/test-cache.yml
@@ -11,34 +11,51 @@ concurrency:
 
 jobs:
   test-setup-cache:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        enable-cache: [ "true", "false", "auto" ]
+        os: ["ubuntu-latest", "selfhosted-ubuntu-arm64"]
     steps:
       - uses: actions/checkout@v4
       - name: Setup with cache
         uses: ./
         with:
-          enable-cache: true
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache
+          enable-cache: ${{ matrix.enable-cache }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache-${{ matrix.os }}-${{ matrix.enable-cache }}
       - run: uv sync
         working-directory: __tests__/fixtures/uv-project
   test-restore-cache:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        enable-cache: [ "true", "false", "auto" ]
+        os: [ "ubuntu-latest", "selfhosted-ubuntu-arm64" ]
     needs: test-setup-cache
     steps:
       - uses: actions/checkout@v4
       - name: Restore with cache
         id: restore
         uses: ./
         with:
-          enable-cache: true
-          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache
+          enable-cache: ${{ matrix.enable-cache }}
+          cache-suffix: ${{ github.run_id }}-${{ github.run_attempt }}-test-setup-cache-${{ matrix.os }}-${{ matrix.enable-cache }}
       - name: Cache was hit
+        if: ${{ matrix.enable-cache == 'true' || (matrix.enable-cache == 'auto' && matrix.os == 'ubuntu-latest') }}
         run: |
           if [ "$CACHE_HIT" != "true" ]; then
             exit 1
           fi
         env:
           CACHE_HIT: ${{ steps.restore.outputs.cache-hit }}
+      - name: Cache was not hit
+        if: ${{ matrix.enable-cache == 'false' || (matrix.enable-cache == 'auto' && matrix.os == 'selfhosted-ubuntu-arm64') }}
+        run: |
+          if [ "$CACHE_HIT" == "true" ]; then
+            exit 1
+          fi
+        env:
+          CACHE_HIT: ${{ steps.restore.outputs.cache-hit }}
       - run: uv sync
         working-directory: __tests__/fixtures/uv-project
   test-setup-cache-requirements-txt:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -84,6 +84,8 @@ jobs:
         with:
           version: "0.3.2"
           checksum: ${{ matrix.checksum }}
+      - run: uv sync
+        working-directory: __tests__/fixtures/uv-project
   test-with-explicit-token:
     runs-on: ubuntu-latest
     steps:

diff --git a/action.yml b/action.yml
@@ -20,7 +20,7 @@ inputs:
     default: ${{ github.token }}
   enable-cache:
     description: "Enable caching of the uv cache"
-    default: "false"
+    default: "auto"
   cache-dependency-glob:
     description:
       "Glob pattern to match files relative to the repository root to control

diff --git a/dist/save-cache/index.js b/dist/save-cache/index.js
diff --git a/dist/setup/index.js b/dist/setup/index.js
diff --git a/src/utils/inputs.ts b/src/utils/inputs.ts
@@ -4,7 +4,7 @@ import path from "node:path";
 export const version = core.getInput("version");
 export const pythonVersion = core.getInput("python-version");
 export const checkSum = core.getInput("checksum");
-export const enableCache = core.getInput("enable-cache") === "true";
+export const enableCache = getEnableCache();
 export const cacheSuffix = core.getInput("cache-suffix") || "";
 export const cacheLocalPath = getCacheLocalPath();
 export const cacheDependencyGlob = core.getInput("cache-dependency-glob");
@@ -15,6 +15,14 @@ export const toolBinDir = getToolBinDir();
 export const toolDir = getToolDir();
 export const githubToken = core.getInput("github-token");
 
+function getEnableCache(): boolean {
+  const enableCacheInput = core.getInput("enable-cache");
+  if (enableCacheInput === "auto") {
+    return process.env.RUNNER_ENVIRONMENT === "github-hosted";
+  }
+  return enableCacheInput === "true";
+}
+
 function getToolBinDir(): string | undefined {
   const toolBinDirInput = core.getInput("tool-bin-dir");
   if (toolBinDirInput !== "") {