Skip to content

Commit 1010da4

Browse files
committed
Tweaks
1 parent 7f50f6e commit 1010da4

File tree

2 files changed

+16
-18
lines changed

2 files changed

+16
-18
lines changed

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -152,23 +152,6 @@ and the [condition and expression syntax](https://help.github.com/en/actions/ref
152152
The `working-directory` input can be set to resolve `.ruby-version`, `.tool-versions`, `mise.toml` and `Gemfile.lock`
153153
if they are not at the root of the repository, see [action.yml](action.yml) for details.
154154

155-
### Authentication Token
156-
157-
By default, this action uses `${{ github.token }}` to authenticate when downloading Ruby release assets from GitHub.
158-
This helps avoid rate limiting issues.
159-
160-
If you're running this action on a GitHub Enterprise Server (GHES) instance, or if you're experiencing rate limiting,
161-
you can provide a custom token:
162-
163-
```yaml
164-
- uses: ruby/setup-ruby@v1
165-
with:
166-
ruby-version: '3.4'
167-
token: ${{ secrets.MY_GITHUB_TOKEN }}
168-
```
169-
170-
In most cases, you don't need to set this input as the default value is sufficient for use on github.com.
171-
172155
### RubyGems
173156

174157
By default, the default RubyGems version that comes with each Ruby is used.
@@ -247,6 +230,22 @@ It is also possible to cache gems manually, but this is not recommended because
247230
There are many concerns which means using `actions/cache` is never enough for caching gems (e.g., incomplete cache key, cleaning old gems when restoring from another key, correctly hashing the lockfile if not checked in, OS versions, ABI compatibility for `ruby-head`, etc).
248231
So, please use `bundler-cache: true` instead and report any issue.
249232

233+
### Authentication Token
234+
235+
By default, this action uses `${{ github.token }}` to authenticate when downloading Ruby release assets from GitHub.
236+
This helps avoid rate limiting issues.
237+
238+
If you're running this action on a GitHub Enterprise Server (GHES) instance, or if you're experiencing rate limiting,
239+
you can provide a custom token:
240+
241+
```yaml
242+
- uses: ruby/setup-ruby@v1
243+
with:
244+
token: ${{ secrets.MY_GITHUB_TOKEN }}
245+
```
246+
247+
In most cases, you don't need to set this input as the default value is sufficient for use on github.com.
248+
250249
## Windows
251250

252251
Note that running CI on Windows can be quite challenging if you are not very familiar with Windows.

action.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ inputs:
4747
token:
4848
description: |
4949
Used to authenticate with GitHub when downloading Ruby release assets.
50-
Since there is a default, this is typically not supplied by the user.
5150
When running this action on github.com, the default value is sufficient.
5251
When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
5352
default: ${{ github.server_url == 'https://github.com' && github.token || '' }}

0 commit comments

Comments
 (0)