docs(orchestrator): submodule profiles, local caching, LFS agents, git hooks

[frostebite]

Summary

Documents the orchestrator build services that run during the build lifecycle — submodule initialization, caching, LFS configuration, and git hooks.

Contents (docs/orchestrator/build-services.md)

• Submodule profiles — YAML format, glob pattern matching, variant overlays, token auth
• Local build caching — Library + LFS filesystem caching, cache key scheme ({platform}-{version}-{branch}), restore/save lifecycle
• Custom LFS transfer agents — register external LFS backends (e.g. elastic-git-storage) via git config
• Git hooks — lefthook/husky detection, npx lefthook install, skip lists via env vars, disable via core.hooksPath

Dependencies

Documents features from: #777

Related documentation:

• docs(orchestrator): CLI provider protocol and provider plugin system #780 (CLI provider protocol and provider plugin system)
• docs(orchestrator): GCP Cloud Run and Azure ACI with multi-storage backends #782 (GCP Cloud Run and Azure ACI with multi-storage backends)

External docs: game-ci/documentation#532 (comprehensive orchestrator docs update)

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for orchestrator build services. Covers submodule profile management with YAML configuration, variant overlays, and pattern matching; local build caching setup; custom LFS transfer agent configuration; and git hooks integration with skip list options. Includes workflow guides, configuration tables, and practical examples.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

A new documentation file has been added describing orchestrator build services, covering submodule profile management, local build caching mechanisms, custom LFS transfer agent configuration, and git hook detection and installation workflows with corresponding configuration examples and input parameters.

Changes

Cohort / File(s)	Summary
Orchestrator Build Services Documentation docs/orchestrator/build-services.md	New documentation file (158 lines) detailing orchestrator build services including submodule profiles with YAML-based selective initialization, local filesystem-based build caching for Unity Library and LFS, custom LFS transfer agent setup via git config, git hook detection (lefthook/husky), and related configuration inputs with usage examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A guide has sprouted, organized and neat,
Submodules and caches, a build service treat,
Git hooks and LFS agents all in a row,
Documentation blooms where configurations flow!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is incomplete according to the repository template. It is missing: Changes section bullet points, Related Issues/PRs with issue numbers, Successful Workflow Run Link, and the required Checklist with appropriate boxes checked/unchecked.	Add required template sections: structured Changes list, explicit Related Issues (#777, #780, #782), Workflow run link, and completed Checklist indicating whether Docs/Readme/Tests have been addressed.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main changes: it covers all four key topics documented (submodule profiles, local caching, LFS agents, git hooks) and clearly indicates this is documentation for the orchestrator.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[frostebite]

Moving to game-ci/documentation

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 31.25%. Comparing base (9d47543) to head (ab04cd6).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #781   +/-   ##
=======================================
  Coverage   31.25%   31.25%           
=======================================
  Files          84       84           
  Lines        4563     4563           
  Branches     1103     1103           
=======================================
  Hits         1426     1426           
  Misses       3137     3137           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]