Skip to content

Commit 6a05326

Browse files
docs: fix documentation drift — env field status and export-gate-schema command (#805)
1 parent 83ce060 commit 6a05326

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

docs/cli.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,11 @@ Both flags route through `ado-aw`'s `discover_ado_aw_pipelines` machinery, which
117117
- `--timeout <secs>` - Hard cap on the polling loop when `--wait` is set (default 1800).
118118
- `--dry-run` - Print the planned `templateParameters` body without calling the ADO API.
119119

120-
- `export-gate-schema` *(hidden; build-time tool)* - Export the gate spec JSON Schema used by the `scripts/ado-script` TypeScript workspace for type codegen. Outputs JSON to stdout or to a file.
120+
### Hidden Build-Time Tools
121+
122+
These commands are not shown in `--help` but are available for contributors working on the ado-aw compiler itself:
123+
124+
- `export-gate-schema` - Export the gate spec JSON Schema used by the `scripts/ado-script` TypeScript workspace for type codegen. Outputs JSON to stdout or to a file.
121125
- `--output, -o <path>` - Write the schema to a file instead of stdout. Parent directories are created automatically.
122126
- See [`docs/ado-script.md`](ado-script.md) for how this command fits into the ado-script build workflow (`cargo run -- export-gate-schema --output schema/gate-spec.schema.json`).
123127

docs/front-matter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ runtimes: # optional runtime configuration (language enviro
5757
# dotnet: # Alternative object format (pin version, configure internal feed via nuget.config)
5858
# version: "8.0.x" # use "global.json" to pin from the repo's global.json
5959
# feed-url: "https://pkgs.dev.azure.com/myorg/_packaging/myfeed/nuget/v3/index.json"
60-
# env: # RESERVED: workflow-level environment variables (not yet implemented)
61-
# CUSTOM_VAR: "value"
60+
env: # workflow-level environment variables
61+
CUSTOM_VAR: "value"
6262
# inlined-imports: false # When true, resolve {{#runtime-import ...}} markers at compile time
6363
# # (default: false — markers are resolved at pipeline runtime, so
6464
# # prompt-body edits do not require recompilation).

0 commit comments

Comments
 (0)