docs: Unity diagnostic log collection (refs unity-builder#740)#568
docs: Unity diagnostic log collection (refs unity-builder#740)#568frostebite wants to merge 4 commits into
Conversation
Documents the Orchestrator's collectUnityLogs / streamUnityLogs flags, including: - Quick-start GHA snippet with artifact upload - Full table of categories (Editor.log, licensing, audit, services-config, Hub logs, crash dumps, build report, bee_backend, Player.log, IL2CPP, project version, package manifest, macOS crash, Windows event log, license file) - Per-platform path resolution table (Linux / macOS / Windows) - Live log streaming behaviour and per-file byte cap - Action inputs and outputs (unityLogsPath, unityLogsManifest) - Sensitive-files guidance for license-file category - Multi-engine note pointing to engine-plugins doc Cross-links from failures-and-diagnostics and common-issues so users hitting the "Unity support wants logs" path land on the new page. Refs: game-ci/unity-builder#740 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
|
|
Visit the preview URL for this PR (updated for commit 0c27a70): https://game-ci-5559f--pr568-docs-unity-log-colle-wuosk2j6.web.app (expires Thu, 14 May 2026 16:31:38 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b |
Documents the no-prior-opt-in workflow: SSH into a self-hosted runner after a failing job, run `game-ci orchestrate --providerStrategy local --collectUnityLogs` and get the same diagnostic bundle without editing the workflow or re-running the build. Calls out the three concrete incident-response use cases this unlocks (overnight failure / locked workflow / live hang debugging) and references the upcoming remote `game-ci logs pull` follow-up command. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds a "Convenient API" section to the Unity Log Collection page documenting the new game-ci logs subcommand group (collect, tail, plus reserved pull/fetch) and the Logs programmatic facade exported from @game-ci/orchestrator. Shows both end-to-end build flows (--collectUnityLogs) and one-shot ad-hoc usage. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Fixes the Code formatting CI check on the docs PR. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Superseded by #569 — the combined branch merges this work in along with the other three docs branches from the May 2026 wave. Closing in favour of the combined PR. |
1 participant
Summary
Companion to game-ci/orchestrator#23 — documents the new
collectUnityLogs/streamUnityLogsflags and the full set of Unity-internal log categories the orchestrator now captures. Also closes the documentation gap from game-ci/unity-builder#740.What's new
manifest.jsonlicense-filecategoryTest plan
yarn buildDocusaurus locally, verify the new page renders and the cross-links resolve/docs/github-orchestrator/advanced-topics/unity-log-collectionmatches the file's directory layout🤖 Generated with Claude Code