From e4297a5188bf6a0fe9ffce2c2aa492e9a80736cd Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 20 May 2026 06:03:49 +0000
Subject: [PATCH] docs: add missing inlined-imports field to README,
 front-matter example, and workflow prompt

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: Copilot <223556219+Copilot@users.noreply.github.com>
---
 README.md                              |  1 +
 docs/front-matter.md                   |  4 ++++
 prompts/create-ado-agentic-workflow.md | 15 +++++++++++++++
 3 files changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 8c9dffc7..4fd89599 100644
--- a/README.md
+++ b/README.md
@@ -252,6 +252,7 @@ the service connections. Approve the permissions and the pipeline is ready.
 | `setup` | list | — | Separate job before agentic task |
 | `teardown` | list | — | Separate job after safe outputs |
 | `network` | object | — | Additional allowed/blocked hosts |
+| `inlined-imports` | boolean | `false` | Resolve `{{#runtime-import …}}` markers at compile time instead of at pipeline runtime. When `false` (default), prompt-body edits do not require recompilation. |
 | `env` | map | — | Workflow-level environment variables (reserved, not yet implemented) |
 
 ### Markdown Body
diff --git a/docs/front-matter.md b/docs/front-matter.md
index 99a954f9..8b63d634 100644
--- a/docs/front-matter.md
+++ b/docs/front-matter.md
@@ -59,6 +59,10 @@ runtimes:                      # optional runtime configuration (language enviro
   #   feed-url: "https://pkgs.dev.azure.com/myorg/_packaging/myfeed/nuget/v3/index.json"
 # env:                          # RESERVED: workflow-level environment variables (not yet implemented)
 #   CUSTOM_VAR: "value"
+# inlined-imports: false        # When true, resolve {{#runtime-import ...}} markers at compile time
+#                               # (default: false — markers are resolved at pipeline runtime, so
+#                               # prompt-body edits do not require recompilation).
+#                               # See docs/runtime-imports.md for full details.
 mcp-servers:
   my-custom-tool:              # containerized MCP server (requires container field)
     container: "node:20-slim"
diff --git a/prompts/create-ado-agentic-workflow.md b/prompts/create-ado-agentic-workflow.md
index df07fde9..ecc9201c 100644
--- a/prompts/create-ado-agentic-workflow.md
+++ b/prompts/create-ado-agentic-workflow.md
@@ -561,6 +561,21 @@ parameters:
 
 Omit `parameters:` if no runtime configuration knobs are needed.
 
+### Step 16 — Inlined Imports (advanced, optional)
+
+Controls when `{{#runtime-import ...}}` markers in the markdown body are resolved. Defaults to `false` — leave it unset for most workflows.
+
+```yaml
+inlined-imports: true   # Resolve all runtime-import markers at compile time
+```
+
+| Value | Behavior |
+|-------|----------|
+| `false` (default) | Markers resolved at pipeline runtime — prompt-body edits do **not** require recompiling |
+| `true` | Markers resolved at compile time — the generated `.lock.yml` is fully self-contained, but prompt-body edits require `ado-aw compile` |
+
+Only set `inlined-imports: true` if you need the pipeline file to be completely standalone (e.g., for environments where the source `.md` file is not accessible at pipeline runtime). See `docs/runtime-imports.md` for full details.
+
 ---
 
 ## Agent Instruction Body