Skip to content

Commit 114c435

Browse files
docs(engines): reduce bloat in AI engines reference (#25010)
1 parent 0f82974 commit 114c435

1 file changed

Lines changed: 10 additions & 32 deletions

File tree

docs/src/content/docs/reference/engines.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,17 @@ engine:
5959
6060
By default, workflows install the latest available version of each engine CLI. To pin to a specific version, set `version` to the desired release:
6161

62+
| Engine | `id` | Example `version` |
63+
|--------|------|-------------------|
64+
| GitHub Copilot CLI | `copilot` | `"0.0.422"` |
65+
| Claude Code | `claude` | `"2.1.70"` |
66+
| Codex | `codex` | `"0.111.0"` |
67+
| Gemini CLI | `gemini` | `"0.31.0"` |
68+
6269
```yaml wrap
63-
# Pin Copilot CLI to a specific release
6470
engine:
6571
id: copilot
6672
version: "0.0.422"
67-
68-
# Pin Claude Code to a specific release
69-
engine:
70-
id: claude
71-
version: "2.1.70"
72-
73-
# Pin Codex to a specific release
74-
engine:
75-
id: codex
76-
version: "0.111.0"
77-
78-
# Pin Gemini CLI to a specific release
79-
engine:
80-
id: gemini
81-
version: "0.31.0"
8273
```
8374

8475
Pinning is useful when you need reproducible builds or want to avoid breakage from a new CLI release while testing. Remember to update the pinned version periodically to pick up bug fixes and new features.
@@ -102,17 +93,15 @@ engine:
10293

10394
### Copilot Custom Configuration
10495

105-
For the Copilot engine, you can specify a specialized prompt to be used whenever the coding agent is invoked. This is called a "custom agent" in Copilot vocabulary. You specify this using the `agent` field. This references a file located in the `.github/agents/` directory:
96+
Use `agent` to reference a custom agent file in `.github/agents/` (omit the `.agent.md` extension):
10697

10798
```yaml wrap
10899
engine:
109100
id: copilot
110-
agent: technical-doc-writer
101+
agent: technical-doc-writer # .github/agents/technical-doc-writer.agent.md
111102
```
112103

113-
The `agent` field value should match the agent file name without the `.agent.md` extension. For example, `agent: technical-doc-writer` references `.github/agents/technical-doc-writer.agent.md`.
114-
115-
See [Copilot Agent Files](/gh-aw/reference/copilot-custom-agents/) for details on creating and configuring custom agents.
104+
See [Copilot Agent Files](/gh-aw/reference/copilot-custom-agents/) for details.
116105

117106
### Engine Environment Variables
118107

@@ -135,17 +124,6 @@ The `api-target` field specifies a custom API endpoint hostname for the agentic
135124

136125
For a complete setup and debugging walkthrough for GHE Cloud with data residency, see [Debugging GHE Cloud with Data Residency](/gh-aw/troubleshooting/debug-ghe/).
137126

138-
```yaml wrap
139-
engine:
140-
id: copilot
141-
api-target: api.acme.ghe.com
142-
network:
143-
allowed:
144-
- defaults
145-
- acme.ghe.com
146-
- api.acme.ghe.com
147-
```
148-
149127
The value must be a hostname only — no protocol or path (e.g., `api.acme.ghe.com`, not `https://api.acme.ghe.com/v1`). The field works with any engine.
150128

151129
**GHEC example** — specify your tenant-specific Copilot endpoint:

0 commit comments

Comments
 (0)