Quickstart
Three things have to happen once: an owner installs the GitHub App, at least one developer adds a Mac, and a workflow asks for a hive runner.
1. Install the GitHub App
Go to Install and choose your organization. You need to be an organization owner. If you are not, GitHub sends the request to the owners and the install completes when one of them approves it.
Installing creates three things:
- The runner labels
hive,hive-4cpu,hive-8cpu. - A private pool for your organization's machines.
- A wallet for the organization, holding the trial grant.
HiveWorker works with GitHub organizations. Personal accounts are not supported in the first release.
2. Add a machine
On an Apple Silicon Mac, install the daemon:
curl -fsSL https://get.hiveworkr.thecomputerplumbers.com/install.sh | shThe daemon is not released yet, so this command does not work today. See Download for status.
The daemon opens a browser window. Sign in with GitHub and approve the machine. If you belong to more than one organization that uses HiveWorker, you pick which pool the machine joins. The daemon then runs a short benchmark and reports as online.
3. Change one line
In a workflow, change the job's runs-on:
Push the change. The job runs on a machine in your pool and reports to GitHub as usual: logs, artifacts and checks appear where they always have.
What to check next
- Jobs run in a Linux arm64 VM. See Labels and sizes for what that means for your actions and images.
- If no machine is free, the job waits in GitHub's queue. See Pools.
Next: Labels and sizes