Skip to content

docs: combined orchestrator documentation updates#564

Merged
frostebite merged 20 commits intomainfrom
docs/combined-orchestrator-updates
May 7, 2026
Merged

docs: combined orchestrator documentation updates#564
frostebite merged 20 commits intomainfrom
docs/combined-orchestrator-updates

Conversation

@frostebite
Copy link
Copy Markdown
Member

Summary

Combined PR replacing #561, #562, #563.

CLI documentation (#561)

  • Clarified CLI command surfaces (build vs orchestrate vs public CLI)
  • Updated getting started, build command, orchestrate command, and other commands pages

Reliability & provider guides (#562)

  • Self-hosted runners guide
  • Failures and diagnostics documentation
  • Build reliability improvements
  • Provider extension docs

Orchestrator backlog features (#563)

  • Renamed "Hot Runner" → "Streaming Runner"
  • Added GC timeout force (gcTimeoutMinutes) docs
  • Added max/min cache entries (maxCacheEntries, minCacheEntries) docs
  • Added config file injection (configFiles) for K8s and Docker providers
  • Added game-ci init CLI command documentation

🤖 Generated with Claude Code

frostebite and others added 19 commits May 6, 2026 18:25
…ostics, caching

New pages:
- Advanced Topics > Self-Hosted Runner Reliability: Library cache strategy
  (HOT/WARM/COLD), DAG file repair, LFS pointer poisoning detection,
  profile-based cache invalidation, workspace-scoped process cleanup,
  licensing race mitigation, pre-crash Library backup pattern
- Advanced Topics > Unity Build Failure Diagnostics: 7-category failure
  classification (LICENSE, CRASH, COMPILE, PACKAGE, SKIP, EXIT_NEG1,
  GENERIC), detection signals, remediation per category, multi-phase retry
  chains with independent budgets, circuit breaker pattern, Step Summary
  integration
- Self-Hosting > Windows Self-Hosted Runner Setup: multi-runner topology,
  NSSM service management with self-healing layers, Unity Hub ghost process
  management, worker count configuration, Accelerator cold-start handling

Updated pages:
- Caching: added self-hosted cache integrity section (DAG repair, LFS
  poisoning, profile fingerprinting)
- Troubleshooting: added quick-fix entries for all 5 common Unity CI failure
  categories

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Rename "Standalone Streaming Hot Runner" to "Streaming Runner"
- Add GC timeout force and max cache entries documentation
- Add maxCacheEntries to caching inputs reference
- Add configFiles documentation to K8s and Docker provider pages
- Add init command documentation for workflow generation

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

Warning

Rate limit exceeded

@frostebite has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 58 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2e56aebf-2968-4eb6-a178-1fe38e51803a

📥 Commits

Reviewing files that changed from the base of the PR and between 0d2925b and ad40072.

📒 Files selected for processing (31)
  • docs/03-github-cli/02-build.mdx
  • docs/03-github-cli/03-remote-builds.mdx
  • docs/03-github-cli/04-configuration-and-plugins.mdx
  • docs/03-github-cli/05-github-action.mdx
  • docs/03-github-cli/index.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/01-introduction.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/03-getting-started.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/04-examples/01-command-line.mdx
  • docs/03-github-orchestrator/01-introduction-to-orchestrator/04-examples/02-github-actions.mdx
  • docs/03-github-orchestrator/05-api-reference.mdx
  • docs/03-github-orchestrator/05-providers/01-overview.mdx
  • docs/03-github-orchestrator/05-providers/03-kubernetes.mdx
  • docs/03-github-orchestrator/05-providers/04-local-docker.mdx
  • docs/03-github-orchestrator/05-providers/06-custom-providers.mdx
  • docs/03-github-orchestrator/05-providers/12-cli-provider-protocol.mdx
  • docs/03-github-orchestrator/05-providers/13-config-defined-providers.mdx
  • docs/03-github-orchestrator/05-providers/_category_.yaml
  • docs/03-github-orchestrator/07-advanced-topics/01-caching.mdx
  • docs/03-github-orchestrator/07-advanced-topics/10-build-services.mdx
  • docs/03-github-orchestrator/07-advanced-topics/12-hot-runner-protocol.mdx
  • docs/03-github-orchestrator/07-advanced-topics/17-build-reliability.mdx
  • docs/03-github-orchestrator/07-advanced-topics/20-self-hosting-and-orchestrator.mdx
  • docs/03-github-orchestrator/07-advanced-topics/21-failures-and-diagnostics.mdx
  • docs/03-github-orchestrator/08-cli/01-getting-started.mdx
  • docs/03-github-orchestrator/08-cli/02-build-command.mdx
  • docs/03-github-orchestrator/08-cli/03-orchestrate-command.mdx
  • docs/03-github-orchestrator/08-cli/04-other-commands.mdx
  • docs/03-github-orchestrator/08-cli/05-init-command.mdx
  • docs/08-docker/05-custom-images.mdx
  • docs/09-troubleshooting/common-issues.mdx
  • docs/12-self-hosting/06-windows-runner-setup.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/combined-orchestrator-updates

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 and usage tips.

@frostebite frostebite requested a review from webbertakken May 6, 2026 21:43
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Cat Gif

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Visit the preview URL for this PR (updated for commit ad40072):

https://game-ci-5559f--pr564-docs-combined-orches-1sw8q77t.web.app

(expires Wed, 13 May 2026 23:08:33 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b

Documents the game-ci build-unity-image command for building Docker
images with custom module combinations. Includes GitHub Actions examples
for both on-the-fly and pre-built workflows.

Refs: game-ci/cli#45, game-ci/cli#46

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@frostebite frostebite merged commit ab8eb11 into main May 7, 2026
9 checks passed
@frostebite frostebite deleted the docs/combined-orchestrator-updates branch May 7, 2026 03:42
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