Garbage Collection

Orchestrator creates cloud resources (containers, stacks, volumes) for each build and cleans them up automatically. If a build fails or is interrupted, resources may be left behind.

  Normal Build                       Failed / Interrupted Build

 ┌──────────┐  ┌──────────┐  Auto   ┌──────────┐  ┌──────────┐
 │ Create   │─►│ Build    │─►Clean  │ Create   │─►│ Build    │──► crash
 │ resources│  │          │  up     │ resources│  │          │
 └──────────┘  └──────────┘         └──────────┘  └──────────┘
                                                       |
                                                       v
                                                  Resources left behind
                                                       |
                                                       v
                                                  ┌─────────────────┐
                                                  │ garbage-collect  │
                                                  │ removes after    │
                                                  │ garbageMaxAge    │
                                                  └─────────────────┘

Use garbage collection to clean up stale resources. See the API Reference for all parameters.

Usage

GitHub Actions

- uses: game-ci/unity-builder@v4
  with:
    providerStrategy: aws
    mode: garbage-collect
    gitPrivateToken: ${{ secrets.GITHUB_TOKEN }}

Command Line

yarn run cli -m garbage-collect --providerStrategy aws

Parameters

Parameter	Default	Description
garbageMaxAge	24	Maximum age in hours before resources are cleaned up.

🔄 Automatic Cleanup

When using the AWS provider, Orchestrator can create a CloudFormation-based cleanup cron job that automatically removes old ECS task definitions and resources. This is controlled by the useCleanupCron parameter (enabled by default).