Skip to content

Commit 1a6f312

Browse files
docs: document inlined-imports field in README and workflow creation prompt (#658)
The `inlined-imports` front-matter field has been implemented and documented in docs/front-matter.md and docs/runtime-imports.md, but was absent from both the README front-matter fields reference table and the create-ado-agentic-workflow.md prompt guide. - Add `inlined-imports` row to the README "Front Matter Fields" table - Add Step 16 to the workflow creation prompt explaining when and how to use the field (default false, trade-off with compile-time resolution) 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 278cfee commit 1a6f312

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ the service connections. Approve the permissions and the pipeline is ready.
252252
| `setup` | list | — | Separate job before agentic task |
253253
| `teardown` | list | — | Separate job after safe outputs |
254254
| `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). |
255256
| `env` | map | — | Workflow-level environment variables (reserved, not yet implemented) |
256257

257258
### Markdown Body

prompts/create-ado-agentic-workflow.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,18 @@ parameters:
561561

562562
Omit `parameters:` if no runtime configuration knobs are needed.
563563

564+
### Step 16 — Inlined Imports (advanced, optional)
565+
566+
By default (`inlined-imports: false`), any `{{#runtime-import …}}` markers in the agent body — including the implicit marker that reloads the body itself — are resolved at **pipeline runtime**. This means editing the `.md` agent body does not require recompiling the `.lock.yml` pipeline.
567+
568+
Set `inlined-imports: true` only when you need a fully self-contained pipeline YAML (e.g., for auditing or air-gapped deployment):
569+
570+
```yaml
571+
inlined-imports: true
572+
```
573+
574+
**Trade-off**: with `inlined-imports: true`, every change to the agent instructions requires running `ado-aw compile` and committing the updated `.lock.yml`. Omit this field (or set it to `false`) for the typical edit-without-recompile workflow.
575+
564576
---
565577

566578
## Agent Instruction Body

0 commit comments

Comments
 (0)