From 7de7abff395128707f4fc7512e43a08fd39334d8 Mon Sep 17 00:00:00 2001 From: Jacob Carlborg Date: Fri, 3 Nov 2023 09:31:17 +0100 Subject: [PATCH] [no ci] Fix #70: Document preferred runner and hypervisor. --- readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/readme.md b/readme.md index 5e8c8de..689badd 100644 --- a/readme.md +++ b/readme.md @@ -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 @@ -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