Skip to content

Commit c0ffe5c

Browse files
jamesadevinegithub-actions[bot]Copilot
authored
docs: fix documentation drift — add job and stage targets to README, AGENTS.md, and create prompt (#548)
All three files (README.md, AGENTS.md, prompts/create-ado-agentic-workflow.md) only documented 'standalone' and '1es' as valid target values, but the compiler has supported 'job' and 'stage' targets (via target: job / target: stage in front matter) since they were added (src/compile/job.rs, src/compile/stage.rs, src/data/job-base.yml, src/data/stage-base.yml). docs/targets.md and docs/front-matter.md correctly documented all four values but the three files above were never updated. - README.md: expand target field type column to include 'job' and 'stage' - AGENTS.md: update docs/targets.md link description to mention all four targets - prompts/create-ado-agentic-workflow.md Step 7: add 'job' and 'stage' rows to the target table and a brief note about trigger-ignore behaviour and job-name prefixing Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent adfda75 commit c0ffe5c

3 files changed

Lines changed: 8 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,8 @@ index to jump to the right page.
193193
`edit`, `cache-memory`, `azure-devops` MCP).
194194
- [`docs/runtimes.md`](docs/runtimes.md)`runtimes:` configuration (Lean 4,
195195
Python, Node.js, .NET).
196-
- [`docs/targets.md`](docs/targets.md) — target platforms: `standalone` and
197-
`1es`.
196+
- [`docs/targets.md`](docs/targets.md) — target platforms: `standalone`,
197+
`1es`, `job`, and `stage`.
198198
- [`docs/safe-outputs.md`](docs/safe-outputs.md) — full reference for every
199199
safe-output tool agents can use to propose actions (PRs, work items, wiki
200200
pages, comments, etc.) plus their per-agent configuration.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ the service connections. Approve the permissions and the pipeline is ready.
235235
|-------|------|---------|-------------|
236236
| `name` | string | **required** | Human-readable name for the agent |
237237
| `description` | string | **required** | One-line summary of the agent's purpose |
238-
| `target` | `standalone` \| `1es` | `standalone` | Pipeline output format |
238+
| `target` | `standalone` \| `1es` \| `job` \| `stage` | `standalone` | Pipeline output format. `job` and `stage` generate reusable ADO YAML templates rather than complete pipelines. |
239239
| `engine` | string or object | `copilot` | Engine identifier or object with `id`, `model`, `timeout-minutes`, etc. |
240240
| `on` | object | — | Unified trigger configuration (`schedule`, `pipeline` completion, `pr` triggers). See [schedule syntax](#schedule-syntax). |
241241
| `pool` | string or object | `vmImage: ubuntu-latest` (standalone) / `AZS-1ES-L-MMS-ubuntu-22.04` (1ES) | Agent pool |

prompts/create-ado-agentic-workflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ pool:
173173

174174
### Step 7 — Target
175175

176-
Defaults to `standalone`. Only include if using 1ES Pipeline Templates.
176+
Defaults to `standalone`. Only include if using a different target.
177177

178178
```yaml
179179
target: 1es
@@ -183,6 +183,10 @@ target: 1es
183183
|---|---|
184184
| `standalone` | Full 3-job pipeline with AWF network sandbox and Squid proxy |
185185
| `1es` | Pipeline extending `1ES.Unofficial.PipelineTemplate.yml`; no custom proxy; MCPs via MCPG |
186+
| `job` | Reusable ADO YAML template with `jobs:` at root — include in an existing pipeline (no triggers or pipeline name) |
187+
| `stage` | Reusable ADO YAML template with `stages:` at root — include as a stage in a multi-stage pipeline |
188+
189+
> **Note**: For `target: job` and `target: stage`, triggers configured via `on:` are ignored with a warning — the parent pipeline controls triggers. Job names are prefixed with the agent name for uniqueness (e.g., `DailyReview_Agent`). See `docs/targets.md` for usage examples.
186190

187191
### Step 8 — MCP Servers
188192

0 commit comments

Comments
 (0)