Skip to content

Commit 153ca5e

Browse files
committed
Update documentation about self-hosted runners
1 parent 0effb2c commit 153ca5e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ On Windows, Ruby 2.4 uses OpenSSL 1.0.2, which is no longer maintained.
3131

3232
### Supported Platforms
3333

34-
The action works for all [GitHub-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners), and [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners), under [certain conditions](#limitations)
34+
The action works for all [GitHub-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners).
3535

3636
| Operating System | Recommended | Other Supported Versions |
3737
| ----------- | -------- | -------- |
@@ -191,11 +191,17 @@ This action follows semantic versioning with a moving `v1` branch.
191191
This follows the [recommendations](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) of GitHub Actions.
192192

193193
## Using self-hosted runners
194-
You must meet the following parameters to use this action with self-hosted runners:
195194

195+
This action might work with [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners)
196+
if the [virtual environment](https://github.com/actions/virtual-environments) is very similar to the ones used by GitHub runners. Notably:
197+
198+
* Make sure to use the same operating system and version.
199+
* Make sure to use the same version of libssl.
196200
* Make sure that the operating system has `libyaml-0` installed
197201
* The runner software is running as user `runner` with a home directory of `/home/runner`, or you have created a symlink for the home directory of whatever user that the runner is running as to `/home/runner`.
198202

203+
In other cases, please use a system Ruby or [compile your own Ruby](https://github.com/postmodern/chruby/wiki#installing-rubies) instead.
204+
199205
## History
200206

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

0 commit comments

Comments
 (0)