|
| 1 | +# CI Changes |
| 2 | + |
| 3 | +This file documents notable changes made to the CI cookbook (`Tools/CI/`), including the motivation, what was changed, and any follow-up actions required. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Wrench 2.12.0 Migration & CI Fixes |
| 8 | +**Branch:** `bugfix/fix-ci-failure-due-to-warnings` |
| 9 | +**Date:** June 2026 |
| 10 | +**Author:** Darren Kelly |
| 11 | + |
| 12 | +### Summary |
| 13 | +Migrated the CI cookbook from `RecipeEngine.Modules.Wrench` 2.2.1 to 2.12.0 and fixed several CI failures that surfaced as a result. |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +### 1. Wrench Version Bump |
| 18 | +**File:** `InputSystem.Cookbook.csproj` |
| 19 | + |
| 20 | +Bumped `RecipeEngine.Modules.Wrench` from `2.2.1` to `2.12.0`. The version in `wrench_config.json` is updated automatically by the regenerate script. |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +### 2. BaseRecipe — Migrated to Wrench 2.x Job Iteration Pattern |
| 25 | +**File:** `Recipes/BaseRecipe.cs` |
| 26 | + |
| 27 | +`GetJobs()` was still using the Wrench 1.x pattern, reading platforms only from `UnityEditors[0]` and iterating `SupportedEditorVersions` as a flat list. This meant per-editor platform customisations were silently ignored for all editor versions except the first. |
| 28 | + |
| 29 | +Migrated to the 2.x pattern: iterates `package.UnityEditors` directly, using `unityEditor.Version.Version` for the version string and `unityEditor.EditorPlatforms.Items` for the platform set. Job names now use `EditorPlatformType` (e.g. `MacOs13`, `MacOs13Arm`) instead of `SystemType` (e.g. `MacOS`) to produce unique names — necessary because Wrench 2.12.0 adds `MacOs13Arm` by default and both `MacOs13` and `MacOs13Arm` share `SystemType.MacOS`. |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +### 3. Mac ARM64 Fix for Unity 6.6 |
| 34 | +**File:** `Settings/InputSystemSettings.cs` |
| 35 | + |
| 36 | +`OverridePackagePlatform` was unconditionally forcing `MacOs13` (Intel) onto all editor versions including Unity 6.6. Wrench 2.12.0 defaults Unity 6.6 to `MacOs13Arm` (Apple Silicon), so this override was reverting 6.6 back to an Intel agent and causing `Bad CPU type in executable` failures on standalone tests. |
| 37 | + |
| 38 | +Fixed by skipping the `MacOs13` override for Unity 6.6, allowing Wrench's default `MacOs13Arm` agent to take effect. |
| 39 | + |
| 40 | +**Jobs fixed:** |
| 41 | +- `StandaloneFunctionalTests - 6000.6 - MacOs13` |
| 42 | +- `StandaloneIl2CppFunctionalTests - 6000.6 - MacOs13` |
| 43 | +- All other custom recipe jobs for Unity 6.6 on Mac |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +### 4. Ubuntu Standalone Tests — Switched to GPU VM |
| 48 | +**File:** `Settings/InputSystemSettings.cs` |
| 49 | + |
| 50 | +The default Ubuntu2204 agent is a CPU-only VM (`Unity::VM`), which uses software rendering. Standalone player tests run graphical processes that are 2–3× slower under software rendering, causing frequent timeouts and flaky failures. |
| 51 | + |
| 52 | +Overrode the Ubuntu2204 agent to use `ResourceType.VmGpu` (`Unity::VM::GPU`) with `package-ci/ubuntu-22.04:v4`. This is consistent with how other Unity teams (Burst, HDRP, UX Engineering) run Linux standalone tests. The GPU VM provisions an NVIDIA RTX 2080 Ti by default. |
| 53 | + |
| 54 | +**Jobs fixed:** |
| 55 | +- `StandaloneFunctionalTests - 6000.0 - Ubuntu2204` |
| 56 | +- `StandaloneFunctionalTests - 6000.3 - Ubuntu2204` |
| 57 | +- All other standalone recipe jobs on Ubuntu2204 |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +### Known Outstanding Issues |
| 62 | + |
| 63 | +- **`parentSpanId` deserialization error** — Unity 6.6 editor builds (from `6000.6.0a8` onwards) include a test framework change (PR #102587 in `unity/unity`) that emits `parentSpanId: ""` instead of `null`, which UTR cannot deserialize. This is a known upstream issue being tracked in PR #109932 in `unity/unity`. No action required on our side; monitor that PR for a fix. |
| 64 | + |
| 65 | +- **`Ubuntu2004 packAndPromotePlatformType` warning** — Wrench logs a warning that `Ubuntu2004` is set as the `packAndPromotePlatformType` but is not in the editor platforms. This is pre-existing and non-blocking (generation still succeeds). Investigate whether `packAndPromotePlatformType` should be updated to `Ubuntu2204`. |
0 commit comments