Skip to content

Commit 0590ca1

Browse files
docs: fix documentation drift — enable command, engine install steps, command field (#597)
1 parent d4fedd5 commit 0590ca1

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,7 @@ Commands:
494494
mcp-http Run as an HTTP MCP server (for MCPG integration)
495495
execute Execute safe outputs (Stage 3)
496496
configure Detect agentic pipelines and update GITHUB_TOKEN on ADO definitions
497+
enable Register ADO build definitions for compiled pipelines and ensure they are enabled
497498

498499
Options:
499500
-v, --verbose Enable info-level logging

docs/engine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ engine:
2929
| `api-target` | string | *(none)* | Custom API endpoint hostname for GHES/GHEC (e.g., `"api.acme.ghe.com"`). Adds `--api-target <hostname>` to the CLI invocation and adds the hostname to the AWF network allowlist. |
3030
| `args` | list | `[]` | Custom CLI arguments appended after compiler-generated args. Subject to shell-safety validation and blocked from overriding compiler-controlled flags (`--prompt`, `--allow-tool`, `--disable-builtin-mcps`, etc.). |
3131
| `env` | map | *(none)* | Engine-specific environment variables merged into the sandbox step's `env:` block. Keys must be valid env var names; values must not contain ADO expressions (`$(`, `${{`) or pipeline command injection (`##vso[`). Compiler-controlled keys (`GITHUB_TOKEN`, `PATH`, `BASH_ENV`, etc.) are blocked. |
32-
| `command` | string | *(none)* | Custom engine executable path (skips default NuGet installation). The path must be accessible inside the AWF container (e.g., `/tmp/...` or workspace-mounted paths). |
32+
| `command` | string | *(none)* | Custom engine executable path (skips the default engine binary installation — NuGet for `target: 1es`, GitHub Releases for all other targets). The path must be accessible inside the AWF container (e.g., `/tmp/...` or workspace-mounted paths). |
3333

3434

3535
### `timeout-minutes`

docs/template-markers.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,20 @@ job- and stage-level templates don't emit a top-level pipeline name.
161161

162162
## {{ engine_install_steps }}
163163

164-
Should be replaced with engine-specific pipeline steps to install the engine binary. Generated by `Engine::install_steps()`. For Copilot, this produces:
164+
Should be replaced with engine-specific pipeline steps to install the engine binary. Generated by `Engine::install_steps()`. The install strategy is **target-aware**:
165+
166+
**For `target: 1es`** — authenticates with an internal Azure Artifacts NuGet feed and installs the package:
165167
- `NuGetAuthenticate@1` task
166-
- `NuGetCommand@2` task to install `Microsoft.Copilot.CLI.linux-x64` (uses `engine.version` if set, otherwise `COPILOT_CLI_VERSION` constant)
168+
- `NuGetCommand@2` task to install `Microsoft.Copilot.CLI.linux-x64` from `pkgs.dev.azure.com/msazuresphere/_packaging/Guardian1ESPTUpstreamOrgFeed` (uses `engine.version` if set, otherwise `COPILOT_CLI_VERSION` constant; omits `-Version` flag when `"latest"`)
167169
- Bash step to copy binary to `/tmp/awf-tools/copilot`
168170
- Bash step to verify installation
169171

172+
**For all other targets (standalone, job, stage)** — downloads from GitHub Releases with SHA256 checksum verification:
173+
- Bash step that: resolves `SHA256SUMS.txt` and the tarball from the GitHub Releases URL for the configured version, verifies the SHA256 checksum, extracts the binary, copies it to `/tmp/awf-tools/copilot`
174+
- Bash step to verify installation
175+
176+
Both paths stage the binary at `/tmp/awf-tools/copilot`.
177+
170178
Returns empty when `engine.command` is set (user provides own binary).
171179

172180
## {{ engine_run }}

0 commit comments

Comments
 (0)