Skip to content

Commit a448ef0

Browse files
jamesadevinegithub-actions[bot]Copilot
authored
docs: fix documentation drift — engine_log_dir path and ado/mod.rs lifecycle commands (#601)
- docs/template-markers.md: correct {{ engine_log_dir }} from ~/.copilot/logs to $HOME/.copilot/logs, matching src/engine.rs log_dir(). Add explanation that tilde does not expand inside double-quoted bash strings, which would cause the directory check to always fail and silently prevent log collection. - AGENTS.md: remove references to unimplemented lifecycle CLI commands (disable, remove, list, run, status, secrets) from the ado/mod.rs description; only the 'enable' command is currently implemented. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0590ca1 commit a448ef0

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Every compiled pipeline runs as three sequential jobs:
7878
│ ├── configure.rs # `configure` CLI command — orchestration shim atop `src/ado/`
7979
│ ├── enable.rs # `enable` CLI command — registers ADO build definitions for compiled pipelines and ensures they are enabled
8080
│ ├── ado/ # Shared Azure DevOps REST helpers (auth, list/match/PATCH/POST)
81-
│ │ └── mod.rs # Used by `configure` and the lifecycle commands (enable, disable, remove, list, run, status, secrets)
81+
│ │ └── mod.rs # Used by `configure` and the `enable` command (ADO REST helpers: auth, list/match/PATCH/POST)
8282
│ ├── detect.rs # Agentic pipeline detection (helper for `configure`)
8383
│ ├── ndjson.rs # NDJSON parsing utilities
8484
│ ├── sanitize.rs # Input sanitization for safe outputs

docs/template-markers.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,9 @@ ADO access tokens (`AZURE_DEVOPS_EXT_PAT`, `SYSTEM_ACCESSTOKEN`) are not part of
216216

217217
## {{ engine_log_dir }}
218218

219-
Should be replaced with the engine's log directory path, generated by `Engine::log_dir()`. For Copilot: `~/.copilot/logs`. Used by log collection steps to copy engine logs to pipeline artifacts.
219+
Should be replaced with the engine's log directory path, generated by `Engine::log_dir()`. For Copilot: `$HOME/.copilot/logs`. Used by log collection steps to copy engine logs to pipeline artifacts.
220+
221+
> **Note:** `$HOME` is used instead of `~` because tilde does not expand inside double-quoted strings in bash. Using `~` would cause the directory check (`[ -d "~/.copilot/logs" ]`) to always fail, silently preventing log collection.
220222

221223
## {{ pool }}
222224

0 commit comments

Comments
 (0)