add cache-local-storage-path

.github/workflows/test-cache.yml

@@ -5,6 +5,10 @@ on:
  branches:
  - main
 
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
 jobs:
  test-setup-cache:
  runs-on: ubuntu-latest
@@ -39,3 +43,39 @@ jobs:
  fi
  env:
  CACHE_HIT: ${{ steps.restore.outputs.cache-hit }}
+
+ test-setup-cache-local:
+ runs-on: oracle-aarch64
+ steps:
+ - uses: actions/checkout@v4
+ - name: Setup with cache
+ uses: ./
+ with:
+ version: '0.11.0'
+ enable-cache: true
+ working-directory: __tests__/fixtures/rye-project
+ cache-prefix: ${{ github.run_id }}-${{ github.run_attempt }}
+ cache-local-storage-path: /tmp/rye-cache
+ - run: rye sync
+ working-directory: __tests__/fixtures/rye-project
+ test-restore-cache-local:
+ runs-on: oracle-aarch64
+ needs: test-setup-cache-local
+ steps:
+ - uses: actions/checkout@v4
+ - name: Restore with cache
+ id: restore
+ uses: ./
+ with:
+ version: '0.11.0'
+ enable-cache: true
+ working-directory: __tests__/fixtures/rye-project
+ cache-prefix: ${{ github.run_id }}-${{ github.run_attempt }}
+ cache-local-storage-path: /tmp/rye-cache
+ - name: Cache was hit
+ run: |
+ if [ "$CACHE_HIT" != "true" ]; then
+ exit 1
+ fi
+ env:
+ CACHE_HIT: ${{ steps.restore.outputs.cache-hit }}

.github/workflows/test-latest-scheduled.yml

@@ -0,0 +1,22 @@
+name: 'test-latest-scheduled'
+on:
+ pull_request:
+ push:
+ branches:
+ - main
+ schedule:
+ - cron: "0 0 * * *"
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ test-rye-sync:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Setup rye
+ uses: ./
+ - run: rye sync
+ working-directory: __tests__/fixtures/rye-project

.github/workflows/test.yml

@@ -5,6 +5,10 @@ on:
  branches:
  - main
 
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
 jobs:
  build:
  runs-on: ${{ matrix.os }}

README.md

@@ -84,6 +84,19 @@ relative to the repository root. This is useful for monorepos.
  working-directory: 'path/to/rye/project'
 ```
 
+#### Local storage path
+
+If you want to save the cache to a local path you can specify the path with the `cache-local-storage-path` input.
+This can be useful if you are on a self hosted runner and want to save time and network traffic.
+
+```yaml
+- name: Enable caching and define a custom cache path
+ uses: eifinger/setup-rye@v1
+ with:
+ enable-cache: true
+ cache-local-storage-path: '/path/to/cache'
+```
+
 ## How it works
 
 This action downloads rye from the releases of the [rye repo](https://github.com/mitsuhiko/rye) and uses the [GitHub Actions Toolkit](https://github.com/actions/toolkit) to cache it as a tool to speed up consecutive runs especially on self-hosted runners.

action.yml

@@ -17,6 +17,9 @@ inputs:
  cache-prefix:
  description: 'Prefix for the cache key'
  required: false
+ cache-local-storage-path:
+ description: 'Local path to store the cache. Will be used instead of the GitHub Actions cache'
+ required: false
 outputs:
  rye-version:
  description: "The installed rye version. Useful when using latest."

package.json

@@ -1,6 +1,6 @@
 {
  "name": "setup-rye",
- "version": "1.4.0",
+ "version": "1.11.0",
  "private": true,
  "description": "TypeScript template action",
  "main": "dist/index.js",