Skip to content

docs: fix documentation drift — add job and stage targets to README, AGENTS.md, and create prompt #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesadevine merged 1 commit into from
May 15, 2026
Merged

docs: fix documentation drift — add job and stage targets to README, AGENTS.md, and create prompt #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@ index to jump to the right page.
`edit`, `cache-memory`, `azure-devops` MCP).
- [`docs/runtimes.md`](docs/runtimes.md) — `runtimes:` configuration (Lean 4,
Python, Node.js, .NET).
- [`docs/targets.md`](docs/targets.md) — target platforms: `standalone` and
`1es`.
- [`docs/targets.md`](docs/targets.md) — target platforms: `standalone`,
`1es`, `job`, and `stage`.
- [`docs/safe-outputs.md`](docs/safe-outputs.md) — full reference for every
safe-output tool agents can use to propose actions (PRs, work items, wiki
pages, comments, etc.) plus their per-agent configuration.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ the service connections. Approve the permissions and the pipeline is ready.
|-------|------|---------|-------------|
| `name` | string | **required** | Human-readable name for the agent |
| `description` | string | **required** | One-line summary of the agent's purpose |
| `target` | `standalone` \| `1es` | `standalone` | Pipeline output format |
| `target` | `standalone` \| `1es` \| `job` \| `stage` | `standalone` | Pipeline output format. `job` and `stage` generate reusable ADO YAML templates rather than complete pipelines. |
| `engine` | string or object | `copilot` | Engine identifier or object with `id`, `model`, `timeout-minutes`, etc. |
| `on` | object | — | Unified trigger configuration (`schedule`, `pipeline` completion, `pr` triggers). See [schedule syntax](#schedule-syntax). |
| `pool` | string or object | `vmImage: ubuntu-latest` (standalone) / `AZS-1ES-L-MMS-ubuntu-22.04` (1ES) | Agent pool |
Expand Down
6 changes: 5 additions & 1 deletion prompts/create-ado-agentic-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ pool:

### Step 7 — Target

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

```yaml
target: 1es
Expand All @@ -183,6 +183,10 @@ target: 1es
|---|---|
| `standalone` | Full 3-job pipeline with AWF network sandbox and Squid proxy |
| `1es` | Pipeline extending `1ES.Unofficial.PipelineTemplate.yml`; no custom proxy; MCPs via MCPG |
| `job` | Reusable ADO YAML template with `jobs:` at root — include in an existing pipeline (no triggers or pipeline name) |
| `stage` | Reusable ADO YAML template with `stages:` at root — include as a stage in a multi-stage pipeline |

> **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.

### Step 8 — MCP Servers

Expand Down