Skip to content

docs: close non-Copilot engine parity gaps for gh aw init and custom engine frontmatter - #53834

Merged
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-document-init-example-gaps
Aug 19, 2026
Merged

docs: close non-Copilot engine parity gaps for gh aw init and custom engine frontmatter#53834
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-document-init-example-gaps

Conversation

Copilot AI commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

cli.md told non-Copilot users that gh aw init "skips these Copilot-specific artifacts" without saying what they get instead, and the reported flat engine: custom form does not exist anywhere in the docs or examples. Documentation-only fix.

setup/cli.md — new "Initializing for non-Copilot engines" subsection

  • Per-artifact parity table: .gitattributes and the dispatcher skill (.github/skills/agentic-workflows/SKILL.md) are created for every engine; only .github/agents/agentic-workflows.md and the MCP wiring (.github/mcp.json + copilot-setup-steps.yml) are Copilot-gated.
  • Replacement path for each skipped artifact: use the dispatcher skill or author an agent file in the target agent's own format; register gh aw mcp-server manually via GH-AW as an MCP Server.
  • States the engine-independent next steps (frontmatter engine: + that engine's auth secret) and that the init-time engine does not constrain per-workflow engine choice.
  • Existing gating sentence now links to the new subsection.

reference/engines.md — custom engine form

Note clarifying that string-form engine: accepts only built-in IDs; third-party engines always use nested engine.id + an imported definition. Verified against the compiler:

engine: custom   # error: invalid engine: custom. Valid engines are: claude, codex, copilot, gemini, pi.
engine:
  id: example-engine
imports:
  - owner/repository/.github/workflows/example-engine.md@v1.2.3

examples/index.md — engine portability

Explains the Copilot-skewed example distribution and that examples port across engines by changing engine: and its auth secret, flagging engine.agent / engine.harness as non-portable with a pointer to the feature comparison table.

…form

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Document non-Copilot init/example parity gaps for engines docs: close non-Copilot engine parity gaps for gh aw init and custom engine frontmatter Aug 18, 2026
Copilot AI requested a review from pelikhan August 18, 2026 22:02
@github-actions

Copy link
Copy Markdown
Contributor

PR Triage

  • Category: docs · Risk: low
  • Score: 30/100 (impact 10, urgency 5, quality 15)
  • Recommended action: defer

Small doc parity fix (23 lines), draft, no urgency. Merge when convenient.

Generated by 🔧 PR Triage Agent · auto · 58.5 AIC · ⌖ 2.15 AIC · ⊞ 8.3K ·

@pelikhan
pelikhan marked this pull request as ready for review August 19, 2026 00:49
Copilot AI balanced review requested due to automatic review settings August 19, 2026 00:49
@pelikhan
pelikhan merged commit e519e9d into main Aug 19, 2026
@pelikhan
pelikhan deleted the copilot/deep-report-document-init-example-gaps branch August 19, 2026 00:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Clarifies engine portability and non-Copilot initialization behavior across the documentation.

Changes:

  • Documents artifacts created or skipped for non-Copilot engines.
  • Clarifies custom engine configuration.
  • Adds guidance for adapting examples between engines.
Show a summary per file
File Description
docs/src/content/docs/setup/cli.md Documents non-Copilot initialization behavior.
docs/src/content/docs/reference/engines.md Clarifies custom engine selection.
docs/src/content/docs/examples/index.md Adds engine portability guidance.

Review details

Suppressed comments (1)

docs/src/content/docs/setup/cli.md:180

  • Changing only engine: and authentication is not sufficient for every example. The engine reference explicitly notes that switching may also require different tools, model names, or network access, beyond the engine.agent and engine.harness cases. The categorical adaptation claim should direct users to review all engine-specific settings.
The engine chosen at `init` time does not restrict workflows: every workflow selects its own engine in frontmatter, and example workflows written for one engine can be adapted to another by changing `engine:` and its authentication secret.
  • Files reviewed: 3/3 changed files
  • Comments generated: 3
  • Review effort level: Balanced

Do not treat imported definitions as supported unless their engine owner explicitly supports them. The OpenCode, Aider, Crush, Cursor, and Kiro files listed above remain samples; copy or adapt them only under the maintenance and support terms provided by their respective owners.

> [!NOTE]
> There is no flat `engine: custom` value. `engine:` in string form only accepts a built-in engine ID (`copilot`, `claude`, `codex`, `gemini`, `pi`); any other value fails compilation. Third-party and self-defined engines always use the nested object form with `engine.id` set to the ID declared by an imported engine definition, as shown above.
| Custom agent `.github/agents/agentic-workflows.md` | ✅ | ❌ | Use the dispatcher skill, or author an agent file in your own agent's format (Claude Code subagents, Codex prompts) from the same instructions |
| MCP wiring: `.github/mcp.json` and `.github/workflows/copilot-setup-steps.yml` | ✅ | ❌ | Register `gh aw mcp-server` in your own MCP host configuration — see [GH-AW as an MCP Server](/gh-aw/reference/gh-aw-as-mcp-server/) |

After `init`, the remaining steps are the same for every engine: pick the engine in workflow frontmatter (`engine: claude`, `engine: codex`, `engine: gemini`, `engine: pi`) and configure that engine's authentication secret. See [AI Engines](/gh-aw/reference/engines/) and [Authentication](/gh-aw/reference/auth/).

## Examples and AI engines

Most examples specify the default Copilot engine or omit `engine:` entirely, so the published example set is not evenly distributed across engines. Examples are engine-portable: to run one on Claude, Codex, Gemini, or Pi, change `engine:` in the workflow frontmatter and configure that engine's authentication secret. Engine-specific options such as `engine.agent` or `engine.harness` are not portable — see the [engine feature comparison](/gh-aw/reference/engines/#engine-feature-comparison) before switching.
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.87.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[deep-report] Document non-Copilot init/example parity gaps (Claude/Codex/custom engine)

3 participants