diff --git a/README.md b/README.md index 72dc926..038f921 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,42 @@ Try running a Tart VM on your Apple Silicon device running macOS Monterey or lat ```shell brew install cirruslabs/cli/tart -tart clone ghcr.io/cirruslabs/macos-monterey-base:latest monterey-base -tart run monterey-base +tart clone ghcr.io/cirruslabs/macos-ventura-base:latest ventura-base +tart run ventura-base ``` -![tart VM view app](Resources/TartScreenshot.png) + ## CI Integration +Tart already powers several CI services mentioned above including our own [Cirrus CI](https://cirrus-ci.org/guide/macOS/) which offers unlimited concurrency with per-second billing. +For services that haven't leveraged Tart yet, we offer fully managed runners via a monthly subscription. +*Cirrus Runners* is the fastest way to get your current CI workflows to benefit from Apple Silicon hardware. No need to manage infrastructure or migrate to another CI provider. +Please read down below about currently supported services. + +### Managed runners for your CI-as-a-service + +At the moment Cirrus Runners only supports GitHub Actions, but we are actively working on adding more options. +Please [email us](mailto:hello@cirruslabs.org) if you are interested in a particular one. + +#### GitHub Actions + +Configuring Cirrus Runners for GitHub Actions is as simple as installing [Cirrus Runners App](https://github.com/apps/cirrus-runners). +After successful installation and subscription configuration, use any of [Ventura images managed by us](https://github.com/cirruslabs/macos-image-templates) in `runs-on`: + +```yaml +name: Test Suite +jobs: + test: + runs-on: ghcr.io/cirruslabs/macos-ventura-xcode:latest +``` + +When workflows are executing you'll see Cirrus on-demand runners on your organization's settings page at `https://github.com/organizations//settings/actions/runners`. + + + +### Self-hosted CI + Tart itself is only responsible for managing virtual machines, but we've built Tart support into a tool called Cirrus CLI also developed by Cirrus Labs. [Cirrus CLI](https://github.com/cirruslabs/cirrus-cli) is a command line tool with one configuration format to execute common CI steps (run a script, cache a folder, etc.) locally or in any CI system. @@ -64,14 +92,14 @@ brew install cirruslabs/cli/cirrus cirrus run ``` -![Cirrus CLI Run](Resources/TartCirrusCLI.gif) + [Cirrus CI](https://cirrus-ci.org/) already leverages Tart to power its macOS cloud infrastructure. The `.cirrus.yml` config from above will just work in Cirrus CI and your tasks will be executed inside Tart VMs in our cloud. **Note:** Cirrus CI only allows [images managed and regularly updated by us](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos). -### Retrieving artifacts from within Tart VMs +#### Retrieving artifacts from within Tart VMs In many cases there is a need to retrieve particular files or a folder from within a Tart virtual machine. For example, the below `.cirrus.yml` configuration defines a single task that builds a `tart` binary and diff --git a/Resources/TartGHARunners.png b/Resources/TartGHARunners.png new file mode 100644 index 0000000..e04fb6f --- /dev/null +++ b/Resources/TartGHARunners.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23728bb5438c88b3d0826170a5fa4b7aaad0fbd94a4769c8d492c9f75b57ba81 +size 155885 diff --git a/Resources/TartScreenshot.png b/Resources/TartScreenshot.png index 103d1a0..de92607 100644 --- a/Resources/TartScreenshot.png +++ b/Resources/TartScreenshot.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3a43f541b1ab0b57ae2060d371cba5dbb1f5c80b89c76434b7154d8144f66e61 -size 205325 +oid sha256:7a4929ca4e02d4968904749028ada7072704d2a52cccb69335e1596452c822c7 +size 1359834