Add input github-token

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

@@ -1,4 +1,4 @@
-name: 'test-latest-scheduled'
+name: 'test-latest'
 on:
   pull_request:
   push:
@@ -29,6 +29,8 @@ jobs:
           fi
       - name: Setup rye
         uses: ./
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: rye sync
         working-directory: __tests__/fixtures/rye-project
       - name: Rye path is not added to .profile
@@ -39,3 +41,11 @@ jobs:
           else
             exit 1
           fi
+  test-without-github-token:
+    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

@@ -36,6 +36,7 @@ jobs:
         uses: ./
         with:
           version: ${{ matrix.rye-version }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: |
           which rye
   test-checksum:
@@ -57,6 +58,7 @@ jobs:
         with:
           version: '0.11.0'
           checksum: ${{ matrix.checksum }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
   test-modify-path-warning:
     runs-on: ubuntu-latest
     steps:
@@ -65,6 +67,7 @@ jobs:
         uses: ./
         with:
           version: '0.21.0'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: which rye
       - name: Rye path is added to .profile
         run: |

README.md

@@ -102,6 +102,17 @@ One option is to use a cron job to delete files older than 7 days like below.
 0 0 * * * find /home/ubuntu/setup-rye-cache -type f -mtime +7 -exec rm -rf {} \;
 ```
 
+### API rate limit
+
+To avoid hitting the error `API rate limit exceeded` you can supply a GitHub token with the `github-token` input.
+
+```yaml
+- name: Install rye and supply a GitHub token
+  uses: eifinger/setup-rye@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
 ## Limitations
 
 1. Currently only Linux and macOS is supported see [issue #10](https://github.com/eifinger/setup-rye/issues/10)

action.yml

@@ -8,6 +8,9 @@ inputs:
   checksum:
     description: 'The checksum of the rye version to install'
     required: false
+  github-token:
+    description: 'Used to increase the rate limit when retrieving versions and downloading rye.'
+    required: false
   enable-cache:
     description: 'Enable caching of .venv'
     default: 'false'