Skip to content

docs: fix documentation drift — env field status and export-gate-schema command #805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesadevine merged 1 commit into from
May 31, 2026
Merged

docs: fix documentation drift — env field status and export-gate-schema command #805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,11 @@ Both flags route through `ado-aw`'s `discover_ado_aw_pipelines` machinery, which
- `--timeout <secs>` - Hard cap on the polling loop when `--wait` is set (default 1800).
- `--dry-run` - Print the planned `templateParameters` body without calling the ADO API.

- `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.
### Hidden Build-Time Tools

These commands are not shown in `--help` but are available for contributors working on the ado-aw compiler itself:

- `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.
- `--output, -o <path>` - Write the schema to a file instead of stdout. Parent directories are created automatically.
- 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`).

Expand Down
4 changes: 2 additions & 2 deletions docs/front-matter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ runtimes: # optional runtime configuration (language enviro
# dotnet: # Alternative object format (pin version, configure internal feed via nuget.config)
# version: "8.0.x" # use "global.json" to pin from the repo's global.json
# 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"
env: # workflow-level environment variables
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).
Expand Down