Skip to content

docs(orchestrator): QoL build services β€” CLI providers, caching, LFS, hooks#535

Draft
frostebite wants to merge 2 commits intodocument-provider-pluginsfrom
docs/build-services
Draft

docs(orchestrator): QoL build services β€” CLI providers, caching, LFS, hooks#535
frostebite wants to merge 2 commits intodocument-provider-pluginsfrom
docs/build-services

Conversation

@frostebite
Copy link
Member

@frostebite frostebite commented Mar 5, 2026

Summary

Documents features from game-ci/unity-builder#777:

  • CLI provider protocol β€” How to write providers in any language (Go, Python, Rust, shell). Covers subcommands, JSON stdin/stdout contract, streaming output, timeouts, error handling. Includes a complete shell script example and CLI vs TypeScript comparison.
  • Submodule profiles β€” YAML-based selective submodule initialization with glob patterns and variant overlays.
  • Local build caching β€” Filesystem cache for Unity Library and LFS objects between local builds.
  • Custom LFS transfer agents β€” Register external Git LFS backends (elastic-git-storage, lfs-s3).
  • Git hooks β€” Detect and install lefthook or husky during builds.

Dependencies

New files

  • docs/03-github-orchestrator/05-providers/06b-cli-provider-protocol.mdx
  • docs/03-github-orchestrator/07-advanced-topics/10-build-services.mdx

…, hooks

Adds a new advanced topics page documenting orchestrator build services:
- Submodule profiles (YAML, glob patterns, variant overlays)
- Local build caching (Library + LFS filesystem cache)
- Custom LFS transfer agents (elastic-git-storage, etc.)
- Git hooks (lefthook/husky detection, skip lists)

Related: game-ci/unity-builder#777

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

coderabbitai bot commented Mar 5, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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: 127c3dd2-7986-4429-bbb2-eeebd427e45e

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/build-services

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.

Adds a new page documenting the CLI provider protocol that lets users
write orchestrator providers in any language (Go, Python, Rust, shell).

Covers: invocation model, JSON stdin/stdout protocol, streaming output,
subcommands with timeouts, shell example, CLI vs TypeScript comparison.

Related: game-ci/unity-builder#777

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@frostebite frostebite changed the title docs(advanced): submodule profiles, caching, LFS agents, git hooks docs(orchestrator): CLI provider protocol, submodule profiles, caching, LFS, hooks Mar 5, 2026
@frostebite frostebite marked this pull request as draft March 5, 2026 07:33
@frostebite frostebite changed the title docs(orchestrator): CLI provider protocol, submodule profiles, caching, LFS, hooks docs(orchestrator): QoL build services β€” CLI providers, caching, LFS, hooks Mar 5, 2026
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

Cat Gif

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