Skip to content

Commit adfda75

Browse files
jamesadevinegithub-actions[bot]Copilot
authored
docs: fix documentation drift — pool defaults and codemod registry (#545)
- README.md: Fix pool field default (was AZS-1ES-L-MMS-ubuntu-22.04 for all targets; correct defaults are vmImage:ubuntu-latest for standalone and AZS-1ES-L-MMS-ubuntu-22.04 for 1ES) - prompts/create-ado-agentic-workflow.md: Fix Step 6 pool guidance to document the correct target-dependent defaults (standalone vs 1ES) - AGENTS.md: Add missing 0002_pool_object_form.rs to architecture tree - docs/codemods.md: Add missing 0002_pool_object_form.rs to file layout listing 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 f2e5556 commit adfda75

4 files changed

Lines changed: 11 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Every compiled pipeline runs as three sequential jobs:
6666
│ │ ├── codemods/ # Front-matter codemods (one file per transformation)
6767
│ │ │ ├── mod.rs # Codemod struct, CODEMODS registry, runner
6868
│ │ │ ├── 0001_repos_unified.rs # Legacy repositories/checkout → repos codemod
69+
│ │ │ ├── 0002_pool_object_form.rs # Legacy scalar pool → object form codemod
6970
│ │ │ └── helpers.rs # take_key, insert_no_overwrite, rename_key, ConflictPolicy
7071
│ │ ├── codemod_integration_test.rs # White-box rewrite-path tests (stub registry injection)
7172
│ │ └── types.rs # Front matter grammar and types

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ the service connections. Approve the permissions and the pipeline is ready.
238238
| `target` | `standalone` \| `1es` | `standalone` | Pipeline output format |
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). |
241-
| `pool` | string or object | `AZS-1ES-L-MMS-ubuntu-22.04` | Agent pool |
241+
| `pool` | string or object | `vmImage: ubuntu-latest` (standalone) / `AZS-1ES-L-MMS-ubuntu-22.04` (1ES) | Agent pool |
242242
| `workspace` | `root` \| `repo` \| `self` \| *alias* | auto | Working directory mode. `self` is an alias for `repo`; any checked-out repo alias is also accepted. |
243243
| `repos` | list | — | Compact repository declarations (replaces legacy `repositories:` + `checkout:`) |
244244
| `mcp-servers` | map | — | MCP server configuration |

docs/codemods.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ Codemods live in `src/compile/codemods/`:
108108
src/compile/codemods/
109109
├── mod.rs # Framework + CODEMODS registry
110110
├── helpers.rs # take_key, insert_no_overwrite, rename_key, ConflictPolicy
111-
└── 0001_repos_unified.rs # Legacy repositories: + checkout: → repos: codemod
111+
├── 0001_repos_unified.rs # Legacy repositories: + checkout: → repos: codemod
112+
└── 0002_pool_object_form.rs # Legacy scalar pool → explicit object form codemod
112113
```
113114

114115
(New codemods are appended as `<NNNN>_<id>.rs` files.)

prompts/create-ado-agentic-workflow.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,19 @@ repos:
153153

154154
### Step 6 — Pool
155155

156-
Defaults to `AZS-1ES-L-MMS-ubuntu-22.04`. Only include if overriding.
156+
Default depends on target: standalone uses `vmImage: ubuntu-latest` (Microsoft-hosted); 1ES uses `name: AZS-1ES-L-MMS-ubuntu-22.04`. Only include if overriding the default.
157157

158-
String form:
158+
String form (self-hosted pool by name):
159159
```yaml
160160
pool: MyCustomPool
161161
```
162162

163-
Object form (needed for 1ES target with explicit OS):
163+
Object form (Microsoft-hosted or explicit OS):
164164
```yaml
165+
pool:
166+
vmImage: ubuntu-latest # Microsoft-hosted (standalone default)
167+
168+
# 1ES pool with explicit OS:
165169
pool:
166170
name: AZS-1ES-L-MMS-ubuntu-22.04
167171
os: linux # "linux" or "windows"

0 commit comments

Comments
 (0)