Skip to content

docs(orchestrator): CLI provider protocol and provider plugin system - #780

Closed
frostebite wants to merge 1 commit into
mainfrom
docs/provider-plugins
Closed

docs(orchestrator): CLI provider protocol and provider plugin system#780
frostebite wants to merge 1 commit into
mainfrom
docs/provider-plugins

Conversation

@frostebite

@frostebite frostebite commented Mar 5, 2026

Copy link
Copy Markdown
Member

Summary

Documents the orchestrator's provider plugin system — how providers are selected, how the CLI protocol works, and how to write custom providers in any language.

Contents (docs/orchestrator/provider-plugins.md)

  • Built-in provider table — AWS, K8s, local, Docker, test, GCP Cloud Run, Azure ACI
  • CLI provider protocol — JSON-over-stdin/stdout with subcommand dispatch, streaming build output, configurable timeouts
  • Shell example — minimal working provider in ~20 lines of bash
  • Dynamic provider loading — load providers from GitHub repos, NPM packages, or local paths
  • ProviderInterface — the 7-method TypeScript contract all providers implement

Dependencies

Documents features from: #777

Related documentation:

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for orchestration provider plugins, including provider protocol specifications, CLI configuration, request/response formats, streaming behavior, timeout semantics, interface requirements, and practical examples for custom provider implementation.

Documents the provider plugin system:
- Built-in provider table (AWS, K8s, local, Docker, test, GCP, Azure)
- CLI provider protocol: JSON-over-stdin/stdout, subcommands, streaming
  output, timeouts
- Minimal shell provider example
- Dynamic provider loading from GitHub, NPM, local paths
- ProviderInterface contract (7 methods)

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

coderabbitai Bot commented Mar 5, 2026

Copy link
Copy Markdown

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

A new documentation file is added that explains how to build orchestration provider plugins, including details about built-in providers, the CLI provider protocol, request/response formats, streaming behavior, timeouts, and examples of minimal provider implementations.

Changes

Cohort / File(s) Summary
Documentation
docs/orchestrator/provider-plugins.md
Comprehensive documentation covering orchestration provider plugins, including built-in providers, CLI protocol specifications, dynamic provider loading, ProviderInterface requirements, streaming output behavior, timeout semantics, and example minimal shell provider implementation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A guide for plugins, clearly penned,
With protocols and methods to comprehend,
Providers dance through orchestrated streams,
Making integration simpler than it seems! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description provides a clear summary of changes and contents, but does not follow the required template structure with Changes, Related Issues, Related PRs, Workflow Run Link, and Checklist sections. Restructure the description to follow the repository template: add a Changes section listing key points, Related Issues/PRs sections, and complete the Checklist section with appropriate checkboxes marked.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and concisely summarizes the main change: adding documentation for the CLI provider protocol and provider plugin system in 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/provider-plugins

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

Copy link
Copy Markdown
Member Author

Moving to game-ci/documentation

@frostebite frostebite closed this Mar 5, 2026
@frostebite
frostebite deleted the docs/provider-plugins branch March 5, 2026 07:25
@github-actions

github-actions Bot commented Mar 5, 2026

Copy link
Copy Markdown

Cat Gif

@codecov

codecov Bot commented Mar 5, 2026

Copy link
Copy Markdown

Codecov Report

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

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #780   +/-   ##
=======================================
  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.

frostebite added a commit to game-ci/orchestrator that referenced this pull request Mar 10, 2026
Consolidates documentation from individual unity-builder PRs into the
standalone orchestrator repository. Updated to reflect the standalone
package architecture with both Action and CLI usage examples.

Consolidates:
- game-ci/unity-builder#780 (CLI provider protocol and provider plugin system)
- game-ci/unity-builder#781 (submodule profiles, local caching, LFS agents, git hooks)
- game-ci/unity-builder#782 (GCP Cloud Run and Azure ACI with multi-storage backends)

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