Skip to content

Commit 973b1ba

Browse files
LinuxBozoeregon
authored andcommitted
Update README to reflect conditions for self-hosted runners
1 parent ef4b00f commit 973b1ba

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 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).
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)
3535

3636
| Operating System | Recommended | Other Supported Versions |
3737
| ----------- | -------- | -------- |
@@ -194,7 +194,11 @@ This follows the [recommendations](https://github.com/actions/toolkit/blob/maste
194194

195195
## Limitations
196196

197-
* This action currently only works with GitHub-hosted runners, not private runners.
197+
### Using self-hosted runners
198+
You must meet the following parameters to use this action with self-hosted runners:
199+
200+
* Make sure that the operating system has `libyaml-0` installed
201+
* 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

199203
## History
200204

0 commit comments

Comments
 (0)