conntac / gitlab-runner-tart

Run GitLab Runner jobs with macOS virtualization for Apple Silicon

🚨 Maintainance notice 🚨

This project has been replaced by a more official implementation of cirruslabs at https://github.com/cirruslabs/gitlab-tart-executor and will not be maintained anymore.

Run GitLab Runner jobs with macOS virtualization for Apple Silicon

What is this?

A set of configuration files which allows gitlab-runner to make use of the macOS virtualization framework. Under the hood, these scripts use the tart commandline tool to provision VMs for jobs. The macOS virtualization framework allows running two macOS virtual machines in parallel.

Installation

Clone this repository onto your build machine and register a custom gitlab-runner to your instance. You need to adjust the paths in prepare_exec, run_exec and cleanup_exec which can also be found in gitlab-runner-example-config.toml.

Install dependencies: brew install gitlab-runner daemonize cirruslabs/cli/tart.

Ensure your host system has an SSH private key. If not, create one using ssh-keygen -t ed25519.

Configurations

• The image can be selected using Gitlab-CI's image: tag. Choose a different tart image, e.g. from https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos. The current default is ghcr.io/cirruslabs/macos-monterey-xcode:14.

References

• Related GitLab.org issue: https://gitlab.com/gitlab-org/gitlab-runner/-/issues/29319

gitlab-runner-tart's Issues

Small adjustments

Hi guys,
I've tried the runner it works almost out of the box. Thanks for sharing this amazing piece of software.

I really want to improve the process of setting the runner and I think it is worth to mention in the README.md that a private key needs to be generated before using this executor.

Second improvement, why would it need to use env variable CUSTOM_ENV_TART_IMAGE in base.sh? Would it be better to use built-in gitlab variable CUSTOM_ENV_CI_JOB_IMAGE? Then in the .gitlab-ci.yml configuration image: can be specified and the configuration will look more similar to other systems:

build-macos:
  extends: .buildMacOS
  image: ghcr.io/cirruslabs/macos-monterey-xcode:14
  tags: [ macos]

If you ok with this approach I could create a pull request.

Mounting host directories

Hello,

First of all, thank you for taking the time to put this project together, it’s very useful!

I’m wondering if it’s currently possible to mount directories from the host into the guest using tart’s --dir option on Ventura, similar to how Docker volumes can be mounted with the docker executor? If not, would you be interested in a PR to implement this?