Skip to content

Commit 8d0be09

Browse files
docs(site): document inlined-imports field in front-matter reference (#738)
1 parent 4fce5dd commit 8d0be09

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

site/src/content/docs/reference/front-matter.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ runtimes: # optional runtime configuration (language enviro
6161
# feed-url: "https://pkgs.dev.azure.com/myorg/_packaging/myfeed/nuget/v3/index.json"
6262
# env: # RESERVED: workflow-level environment variables (not yet implemented)
6363
# CUSTOM_VAR: "value"
64+
# inlined-imports: false # When true, resolve {{#runtime-import ...}} markers at compile time
65+
# # (default: false -- markers are resolved at pipeline runtime, so
66+
# # prompt-body edits do not require recompilation).
67+
# # See the Inlined Imports section below for details.
6468
mcp-servers:
6569
my-custom-tool: # containerized MCP server (requires container field)
6670
container: "node:20-slim"
@@ -236,6 +240,27 @@ becomes a `repos:` entry, with `checkout: false` added for entries
236240
that weren't listed under `checkout:`. Mixing the legacy fields with
237241
an existing `repos:` block is rejected; pick one shape.
238242

243+
## Inlined Imports
244+
245+
The `inlined-imports:` field controls when `{{#runtime-import ...}}`
246+
markers in the markdown body are resolved. It defaults to `false`.
247+
See the [Runtime imports reference](/ado-aw/reference/runtime-imports/) for the full marker
248+
syntax, path resolution rules, and runtime behavior.
249+
250+
When `inlined-imports: false` (the default), the compiler leaves runtime-import
251+
markers to be resolved on the pipeline runner. Prompt-body edits do not require
252+
recompiling the generated YAML — the pipeline fetches the latest prompt at
253+
runtime automatically.
254+
255+
When `inlined-imports: true`, the compiler resolves all runtime-import
256+
markers at compile time, including the implicit top-level marker that
257+
normally reloads the body itself. The emitted YAML contains the fully
258+
expanded prompt body, so the pipeline file is self-contained.
259+
260+
The trade-off is that the generated YAML is larger, and prompt-body
261+
edits require `ado-aw compile` plus committing the updated pipeline
262+
file.
263+
239264
## Filter Validation
240265

241266
The compiler validates filter configurations at compile time and will emit

0 commit comments

Comments
 (0)