Skip to content

Commit 679e23d

Browse files
committed
Improve documentation about the self-hosted input
* Fixes #535
1 parent 9f4cc09 commit 679e23d

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,9 @@ In other cases, you will need to install Ruby in the runner tool cache as shown
263263
(run it so it will show you where to install Ruby).
264264
You could of course also not use this action and e.g. use Ruby from a system package or use a Docker image instead.
265265

266+
See also the [`self-hosted:` input](action.yml).
267+
You can set it to `true` if you want to use custom-built Rubies in your self-hosted toolcache instead of prebuild Rubies.
268+
266269
## History
267270

268271
This action used to be at `eregon/use-ruby-action` and was moved to the `ruby` organization.

action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ inputs:
3434
description: |
3535
Consider the runner as a self-hosted runner, which means not using prebuilt Ruby binaries which only work
3636
on GitHub-hosted runners or self-hosted runners with a very similar image to the ones used by GitHub runners.
37-
The default is to detect this automatically based on the OS, OS version and $RUNNER_TOOL_CACHE.
37+
The default is to detect this automatically based on the OS, OS version and architecture.
3838
outputs:
3939
ruby-prefix:
4040
description: 'The prefix of the installed ruby'

common.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ const GitHubHostedPlatforms = [
173173
'windows-2022-x64',
174174
]
175175

176-
// Actually a self-hosted runner for which the OS and OS version does not correspond to a GitHub-hosted runner image,
176+
// Actually a self-hosted runner for which the OS and OS version does not correspond to a GitHub-hosted runner image,
177177
export function isSelfHostedRunner() {
178178
if (inputs.selfHosted === undefined) {
179179
throw new Error('inputs.selfHosted should have been already set')

dist/index.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)