Skip to content

Commit 3c50dad

Browse files
github-actions[bot]CopilotCopilotjamesadevine
authored
docs: add missing inlined-imports field to README, front-matter example, and workflow prompt (#659)
The FrontMatter struct has an inlined-imports: bool field (documented in docs/front-matter.md's 'Inlined Imports' section) but it was absent from: - README.md front matter fields table - docs/front-matter.md YAML example (other rarely-used fields like env: are shown commented-out in the example) - prompts/create-ado-agentic-workflow.md (the step-by-step guide AI agents use to create new workflows) This PR adds the field to all three locations so contributors and AI agents can discover it without having to read docs/front-matter.md in full. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com> Co-authored-by: James Devine <james_a_devine@outlook.com>
1 parent 615704d commit 3c50dad

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -238,9 +238,9 @@ the service connections. Approve the permissions and the pipeline is ready.
238238
| `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). |
241-
| `pool` | string or object | `vmImage: ubuntu-22.04` (standalone) / `AZS-1ES-L-MMS-ubuntu-22.04` (1ES) | Agent pool |
241+
| `pool` | string or object | `vmImage: ubuntu-22.04` (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. |
243-
| `repos` | list | — | Compact repository declarations (replaces legacy `repositories:` + `checkout:`) |
243+
| `repos` | list | — | Compact repository declarations (replaces legacy `repositories:` + `checkout:`) |
244244
| `mcp-servers` | map | — | MCP server configuration |
245245
| `tools` | object | — | Tool configuration (`bash`, `edit`, `cache-memory`, `azure-devops`) |
246246
| `runtimes` | object | — | Runtime environment configuration (`lean`, `python`, `node`, `dotnet`) |
@@ -251,9 +251,9 @@ the service connections. Approve the permissions and the pipeline is ready.
251251
| `post-steps` | list | — | Inline steps after agent runs |
252252
| `setup` | list | — | Separate job before agentic task |
253253
| `teardown` | list | — | Separate job after safe outputs |
254-
| `network` | object | — | Additional allowed/blocked hosts |
255-
| `inlined-imports` | boolean | `false` | When `true`, resolves all `{{#runtime-import ...}}` markers at compile time; the generated YAML is self-contained but prompt-body edits require recompilation. See [runtime imports](docs/runtime-imports.md). |
256-
| `env` | map | — | Workflow-level environment variables (reserved, not yet implemented) |
254+
| `network` | object | — | Additional allowed/blocked hosts |
255+
| `inlined-imports` | boolean | `false` | When `true`, resolves all `{{#runtime-import }}` markers at compile time; the generated YAML is self-contained but prompt-body edits require recompilation. See [runtime-imports.md](docs/runtime-imports.md). |
256+
| `env` | map | — | Workflow-level environment variables (reserved, not yet implemented) |
257257

258258
### Markdown Body
259259

@@ -557,4 +557,4 @@ for automated releases via `release-please`.
557557

558558
## License
559559

560-
See [LICENSE](LICENSE) for details.
560+
See [LICENSE](LICENSE) for details.

docs/front-matter.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ runtimes: # optional runtime configuration (language enviro
5959
# feed-url: "https://pkgs.dev.azure.com/myorg/_packaging/myfeed/nuget/v3/index.json"
6060
# env: # RESERVED: workflow-level environment variables (not yet implemented)
6161
# CUSTOM_VAR: "value"
62+
# inlined-imports: false # When true, resolve {{#runtime-import ...}} markers at compile time
63+
# # (default: false — markers are resolved at pipeline runtime, so
64+
# # prompt-body edits do not require recompilation).
65+
# # See docs/runtime-imports.md for full details.
6266
mcp-servers:
6367
my-custom-tool: # containerized MCP server (requires container field)
6468
container: "node:20-slim"

0 commit comments

Comments
 (0)