Skip to content

Commit

Permalink
[no ci] Fix #70: Document preferred runner and hypervisor.
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-carlborg committed Nov 3, 2023
1 parent 4d43040 commit 7de7abf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,10 @@ which runners they can run on.
| `xhyve` | ❌ | ✅ | ✅ | ✅ | ❌ |
| `qemu` | ✅ | ✅ | ✅ | ✅ | ✅ |

`xhyve` is in general slightly faster than `qemu`. `xhyve` might have slightly
larger boot overhead due to the need to discover the IP-address. `qemu` is
slightly more stable than `xhyve`.

### Runners

This section lists the different combinations of platforms and on which runners
Expand All @@ -227,6 +231,11 @@ they can run.
| **Linux** | ✅ | ✅ | ✅ | ✅ |
| **macos-10.15**, **macos-11**, **macos-12** | ✅ | ✅ | ✅ | ❌ |

macOS runners are, in general, preferred. They support hardware accelerated
nested virtualization, making them significantly faster than the Linux runners.
This only applies when the runner architecture and the guest architecture are
the same, in this case `x86-64`.

## `Under the Hood`

GitHub Actions currently only support macOS, Linux, and
Expand Down

0 comments on commit 7de7abf

Please sign in to comment.