Skip to content

docs(orchestrator): next-gen features and advanced topics#538

Draft
frostebite wants to merge 7 commits intomainfrom
docs/test-workflow-hot-runners
Draft

docs(orchestrator): next-gen features and advanced topics#538
frostebite wants to merge 7 commits intomainfrom
docs/test-workflow-hot-runners

Conversation

@frostebite
Copy link
Member

@frostebite frostebite commented Mar 5, 2026

Summary

Comprehensive documentation for Orchestrator Next-Gen features and advanced topics. Adds 12 new documentation pages covering experimental features, CI dispatch providers, and advanced deployment guides.

New Pages (12 total)

Next-Gen Feature Documentation

Page File Covers
Test Workflow Engine 11-test-workflow-engine.mdx YAML suite definitions, taxonomy filters (7 dimensions), structured results (JUnit/JSON), sequential execution with dependencies
Hot Runner Protocol 12-hot-runner-protocol.mdx Persistent process-based providers, extensible transports (Named Pipe, File, HTTP, WebSocket, SignalR), runner labels, health monitoring, editor-tools companion
Build Output System 13-build-output-system.mdx Generic artifact system, 8 built-in output types, manifest generation, upload handlers (GitHub Artifacts, rclone, local), compression, retention
Incremental Sync Protocol 14-incremental-sync-protocol.mdx 4 sync strategies (full, git-delta, direct-input, storage-pull), state management, drift detection, overlay apply/revert

CI Dispatch & Infrastructure Provider Pages

Page File Covers
GitHub Actions Dispatch 04-github-actions-dispatch.mdx Dispatch workflow_dispatch to other repos/orgs, token auth, ref resolution, log streaming
GitLab CI Dispatch 05-gitlab-ci-dispatch.mdx Trigger GitLab pipelines via API, project ID, trigger tokens, artifact retrieval
Remote PowerShell 06-remote-powershell.mdx Direct execution on dedicated machines via WinRM/SSH, credential handling
Ansible 07-ansible.mdx Build fleets managed by Ansible playbooks, inventory, vault, extra-vars

Advanced Topics

Page File Covers
Massive Projects 15-massive-projects.mdx Two-level workspace architecture, move-centric caching for 50GB+ Library folders, custom LFS agents, performance tips for 100GB+ projects
Monorepo Support 16-monorepo-support.mdx Submodule profiles with glob patterns, variant overlays, multi-product CI matrix, framework configuration centralization
Build Reliability 17-build-reliability.mdx Git integrity checks, reserved filename cleanup, build archival with retention, self-hosted runner hardening

Provider Category

File Purpose
_category_.yaml Updated providers sidebar category to include new dispatch/infrastructure providers

File Changes Summary

docs/03-github-orchestrator/05-providers/04-github-actions-dispatch.mdx    (new)
docs/03-github-orchestrator/05-providers/05-gitlab-ci-dispatch.mdx         (new)
docs/03-github-orchestrator/05-providers/06-remote-powershell.mdx          (new)
docs/03-github-orchestrator/05-providers/07-ansible.mdx                    (new)
docs/03-github-orchestrator/05-providers/_category_.yaml                   (modified)
docs/03-github-orchestrator/07-advanced-topics/11-test-workflow-engine.mdx (new)
docs/03-github-orchestrator/07-advanced-topics/12-hot-runner-protocol.mdx  (new)
docs/03-github-orchestrator/07-advanced-topics/13-build-output-system.mdx  (new)
docs/03-github-orchestrator/07-advanced-topics/14-incremental-sync-protocol.mdx (new)
docs/03-github-orchestrator/07-advanced-topics/15-massive-projects.mdx     (new)
docs/03-github-orchestrator/07-advanced-topics/16-monorepo-support.mdx     (new)
docs/03-github-orchestrator/07-advanced-topics/17-build-reliability.mdx    (new)

Related Issues (game-ci/unity-builder)

  • #788 — Test Workflow Engine
  • #789 — Hot Runner Protocol
  • #792 — Generic Artifact System
  • #793 — Incremental Sync Protocol
  • #802 — Massive Projects documentation
  • #803 — Monorepo Support documentation
  • #805 — CI Dispatch Providers
  • #807 — Build Reliability

Related PRs (game-ci/unity-builder)

  • #790 — Test workflow engine implementation (complete, 43 tests)
  • #791 — Hot runner protocol implementation (complete, 35 tests)
  • #798 — Generic artifact system implementation (complete, 36+ tests)
  • #799 — Incremental sync protocol implementation (complete, 42 tests)
  • #806 — CI dispatch providers implementation (complete, 91 tests)
  • #808 — Build reliability implementation (complete, 5 tests)

Test plan

  • Pages render correctly in Docusaurus
  • Code examples are syntactically valid YAML/bash
  • Cross-links between pages resolve correctly
  • Sidebar navigation includes all new pages in correct order

Add documentation for two new orchestrator features:
- Test Workflow Engine: YAML-based test suite definitions, taxonomy filters, structured results
- Hot Runner Protocol: extensible runner registration, persistent editor providers

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 5, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3b452749-1eaf-4b05-8d38-6f0beed3a58a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/test-workflow-hot-runners

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 and others added 3 commits March 5, 2026 09:09
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add two new documentation pages to the orchestrator advanced topics:
- 15-massive-projects.mdx: Two-level workspaces, move-centric caching,
  custom LFS agents, and performance tips for 100GB+ projects
- 16-monorepo-support.mdx: Submodule profiles, variant overlays,
  multi-product CI matrix, and framework configuration patterns

Closes game-ci/unity-builder#802
Closes game-ci/unity-builder#803

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@frostebite frostebite changed the title docs: test workflow engine and hot runner protocol docs(orchestrator): next-gen features and advanced topics Mar 5, 2026
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

Cat Gif

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

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

https://game-ci-5559f--pr538-docs-test-workflow-h-ye3lmn2q.web.app

(expires Thu, 12 Mar 2026 13:10:31 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b

frostebite and others added 3 commits March 5, 2026 12:10
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…s pages

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

1 participant