Skip to content

docs: correct stale unityVersion input description - #327

Merged
frostebite merged 1 commit into
mainfrom
fix/unity-version-input-doc
Sep 9, 2026
Merged

frostebite merged 1 commit into
mainfrom
fix/unity-version-input-doc

Conversation

@frostebite

@frostebite frostebite commented Sep 9, 2026

Copy link
Copy Markdown
Member

Summary

Found while investigating a community report (Discord) about a Unity 6000.6.x retry-cycle failure in a downstream user's workflow (MirrorNetworking/Mirror, which runs a matrix of unityVersion overrides against this action). While confirming their per-job unityVersion override still works correctly under the thin-wrapper (#310), I noticed the input's own description contradicts the code.

action.yml currently says:

A value other than "auto" for a full project is currently ignored - the underlying game-ci CLI always detects the version from the checked-out project and has no override flag yet.

That hasn't been true since #310. src/test-args.ts maps a non-"auto" unityVersion to an explicit --engineVersion=<value> CLI flag:

const unityVersion = getInput('unityVersion') || 'auto';
if (unityVersion !== 'auto') {
  args.push(`--engineVersion=${unityVersion}`);
}

and game-ci/cli's engine-detection middleware genuinely respects that as an override rather than clobbering it with auto-detection - covered by its own test, 'respects an explicit --engineVersion instead of overwriting it'.

As written, the description tells every reader that per-job version overrides don't work at all - which is exactly the pattern a CI matrix testing one project against several Unity versions relies on (Mirror's own use case). This PR only corrects the description text to match actual behavior; no code changes.

Test plan

  • Confirmed the description was the only stale part - test-args.ts's mapping and the CLI's engine-detection override behavior were both already correct and already covered by existing tests
  • yarn test - all 20 tests pass (unaffected, doc-only change)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that specifying a Unity version for a full project overrides the version detected from the checked-out project.
    • Documented that the selected version is passed to the underlying command-line tool as an explicit engine version override.

The description claimed a non-"auto" unityVersion for a full project
is "currently ignored" with "no override flag yet" - that hasn't been
true since the thin-wrapper rewrite (#310): test-args.ts maps it to an
explicit --engineVersion=<value> CLI flag, which game-ci/cli's
engine-detection middleware genuinely respects as an override rather
than clobbering it (see its own "respects an explicit --engineVersion
instead of overwriting it" test).

Misleading as written - it tells every reader of the input docs that
per-job version overrides don't work, which is exactly the pattern a
matrix testing one project against several Unity versions relies on.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: d293960c-d95c-4999-a9a9-19e452d135c9

📥 Commits

Reviewing files that changed from the base of the PR and between 32e5771 and 8d92861.

📒 Files selected for processing (1)
  • action.yml

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The unityVersion input description now documents that non-auto values for full projects pass to the game-ci CLI as --engineVersion overrides.

Changes

Unity version documentation

Layer / File(s) Summary
Document Unity version override behavior
action.yml
The unityVersion description now states that a non-auto value overrides the Unity version detected from the project.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 8d928

The action input documentation now accurately describes the existing Unity version override behavior without changing runtime code or deployment behavior. No merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: correcting outdated documentation for the unityVersion input.
Description check ✅ Passed The description clearly explains the documentation correction, provides relevant technical context, and documents the test plan. It does not use all template headings and does not include a successful…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/unity-version-input-doc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@frostebite
frostebite enabled auto-merge (squash) September 9, 2026 01:13
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

Cat Gif

@frostebite
frostebite merged commit 207c328 into main Sep 9, 2026
174 of 175 checks passed
@frostebite
frostebite deleted the fix/unity-version-input-doc branch September 9, 2026 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants