Getting Started

GetMac natively integrates with GitHub Actions to provide MacOS runners for CI/CD workflows.

Note: You do not need to create a virtual machine yourself. Once your repository is connected and a job uses runs-on: getmac, a runner is provisioned for that job automatically and deleted the moment the job finishes — you are billed only for the job's own runtime. Creating an instance by hand does not make your workflows run, and because every plan allows a limited number of instances at once, a manually created instance holds one of those slots while your workflow jobs wait for it to be deleted.

Connecting to Your GitHub

1. Click the "Connect GitHub" button in the GitHub Runners section.

   

2. Log in to your GitHub account.

   

3. Choose which repositories you want to allow GetMac to access.

   

4. A confirmation about the successful connection will appear.

   

To use GetMac runners in your GitHub Actions workflows, simply update the runs-on field in your workflow configuration file as shown below:

- runs-on: macos-latest
+ runs-on: getmac

Once configured, start a GitHub Actions workflow, and your jobs will run seamlessly on GetMac's MacOS runners.

Resources

• GitHub Docs: Runners
• Runner Images — Installed Tools
• Runner Images — Workflow Labels