Skip to main content
Version: v2 (current)

Introduction

Concept - What Does Cloud Runner Do

Cloud Runner enables you to run, build and test workflows in the cloud, right from GitHub actions. Builder will automatically provision an environment at a Cloud Provider such as GCP and AWS. It will then send the project to be built and/or tested depending on your workflow configuration.

Cloud Runner is especially useful for game development because it supports large projects. Cloud Runner provides first class support for the Unity game engine.

Cloud Runner uses git to track and transfer your projects and uses native cloud services such as AWS Fargate and Kubernetes to run your jobs. Other version control systems are not actively supported.

Why cloud runner?

  1. Extended options and more control over disk size, memory and CPU. You can build projects of almost any size.
  2. Scale up to much larger numbers of builds easily and fully on demand.
  3. Run custom jobs and extend the system for any workload.
  4. Create resources on-demand, we have made an effort to make sure that it costs you nothing while there are no builds running (no guarantees).

Why not cloud runner?

  1. Your project is small in size. Below 5GB Cloud Runner should not be needed.
  2. You already have servers running you can use for capacity.
  3. You strongly prefer to avoid the addition of time to your pipeline, slowing down results.

Although the speed of a CI pipelines is an important metric to consider, there are real challenges for game development pipelines.

This solution prefers convenience, ease of use, scalability, throughput and flexibility.

Faster solutions exist, but would all involve self-hosted hardware with an immediate local cache of the large project files and working directory and a dedicated server.

Cloud Runner Release Status

Cloud Runner is in "active development" ⚠️🔨

Cloud Runner overall release status: preview This means some APIs may change, features are still being added but the minimum feature set works and is stable.

Release Stages: experimental ➡️ preview ➡️ full release

You must use a provider with Cloud Runner, each provider's release status is described below. This indicates the stability and support for cloud runner features and workflows.

Development

Cloud Runner is actively maintained and kept stable by the Game CI open source project contributors.

💬suggestions, 🐛bugs and ↕️Minor changes are tracked as GitHub issues:

You can also explore the development roadmap page.

Community

Share your feedback with us!

Supported Cloud Runner Platforms

| Cloud Provider Platform | Release Status          |
| ----------------------- | ----------------------- |
| Kubernetes | ✔️ experimental release |
| AWS | ✔️ preview release |
| GCP | ⚠ Considered |
| Azure | ⚠ Considered |

Note for Kuberentes support: Usually the cluster needs to be up and running at all times, as starting up a cluster is slow. Use Google Cloud's Kubernetes Autopilot you can scale down to the free tier automatically while not in use.

| Git Platform          | Release Status     |
| --------------------- | ------------------ |
| GitHub | ✔️ preview release |
| GitLab | ✔️ preview release |
| Command Line | ✔️ preview release |
| Any Git repository | ✔️ preview release |
| Any Git automation/Ci | ✔️ preview release |

Releases

All cloud runner releases are currently packaged and released with game-ci's unity-builder module: Game CI Releases - GitHub

History up to latest open incoming changes for release can be found here: Cloud Runner PRs - GitHub

You can see further information about configuring the release version on the Configuration page.