Skip to content

Commit 106886d

Browse files
authored
docs: fix documentation drift for architecture tree and CLI commands (#1050)
1 parent 3682618 commit 106886d

2 files changed

Lines changed: 29 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Every compiled pipeline runs as three sequential jobs:
7272
│ │ ├── job_ir.rs # Job target typed-IR builder
7373
│ │ ├── stage.rs # Stage-level ADO template compiler (target: stage)
7474
│ │ ├── stage_ir.rs # Stage target typed-IR builder
75+
│ │ ├── source_path_guard.rs # Validation guard for untrusted workflow source-path inputs used by audit + mcp_author
7576
│ │ ├── gitattributes.rs # .gitattributes management for compiled pipelines
7677
│ │ ├── filter_ir.rs # Filter expression IR: Fact/Predicate types, lowering, validation, codegen
7778
│ │ ├── pr_filters.rs # PR trigger filter generation (native ADO + gate steps)
@@ -84,7 +85,14 @@ Every compiled pipeline runs as three sequential jobs:
8485
│ │ │ ├── exec_context/ # Always-on execution-context extension (issue #860)
8586
│ │ │ │ ├── mod.rs # ExecContextExtension; CompilerExtension impl; contributor fan-out
8687
│ │ │ │ ├── contributor.rs # Internal ContextContributor trait + Contributor enum
87-
│ │ │ │ └── pr.rs # PrContextContributor — stages aw-context/pr/* for PR builds
88+
│ │ │ │ ├── ci_push.rs # CiPushContextContributor — push-build context facts for CI runs
89+
│ │ │ │ ├── manual.rs # ManualContextContributor — manually queued build context facts
90+
│ │ │ │ ├── pipeline.rs # PipelineContextContributor — shared pipeline/run metadata facts
91+
│ │ │ │ ├── pr.rs # PrContextContributor — stages aw-context/pr/* for PR builds
92+
│ │ │ │ ├── pr_checks.rs # PrChecksContextContributor — PR validation / policy-check facts
93+
│ │ │ │ ├── repo.rs # RepoContextContributor — repository identity / remote facts
94+
│ │ │ │ ├── schedule.rs # ScheduleContextContributor — scheduled-run context facts
95+
│ │ │ │ └── workitem.rs # WorkItemContextContributor — linked work-item context facts
8896
│ │ │ ├── azure_cli.rs # Always-on Azure CLI extension (runtime detection, AWF mounts, az allowlist)
8997
│ │ │ └── tests.rs # Extension integration tests
9098
│ │ ├── codemods/ # Front-matter codemods (one file per transformation)
@@ -112,6 +120,9 @@ Every compiled pipeline runs as three sequential jobs:
112120
│ ├── fuzzy_schedule.rs # Fuzzy schedule parsing
113121
│ ├── logging.rs # File-based logging infrastructure
114122
│ ├── mcp.rs # SafeOutputs MCP server (stdio + HTTP)
123+
│ ├── mcp_author/ # Author-facing read-only MCP server for local IDE/Copilot Chat integrations
124+
│ │ ├── mod.rs # Tool router + handlers for inspect/graph/whatif/lint/catalog/trace/audit
125+
│ │ └── tests.rs # MCP-author integration / contract tests
115126
│ ├── configure.rs # `configure` CLI command (deprecated) — hidden alias forwarding to `secrets set GITHUB_TOKEN`
116127
│ ├── secrets.rs # `secrets set/list/delete` subcommand group — manages pipeline variables (never prints values from `list`)
117128
│ ├── enable.rs # `enable` CLI command — registers ADO build definitions for compiled pipelines and ensures they are enabled
@@ -129,6 +140,7 @@ Every compiled pipeline runs as three sequential jobs:
129140
│ │ ├── model.rs # AuditData and supporting report structs
130141
│ │ ├── findings.rs # Finding severity levels and structured finding types
131142
│ │ ├── cache.rs # Artifact download cache (keyed on build-id)
143+
│ │ ├── pipeline_graph.rs # IR/runtime graph correlation that populates AuditData.pipeline_graph
132144
│ │ ├── url.rs # Build-reference parsing (bare ID, full ADO URL)
133145
│ │ ├── analyzers/ # Per-signal analyzers that populate AuditData sections
134146
│ │ │ ├── mod.rs
@@ -144,10 +156,16 @@ Every compiled pipeline runs as three sequential jobs:
144156
│ │ ├── mod.rs
145157
│ │ ├── console.rs # Human-readable console report
146158
│ │ └── json.rs # Machine-readable AuditData JSON
147-
│ ├── inspect/ # `ado-aw inspect` / `graph` / (planned) `trace` / `whatif` / `lint` / `catalog` — read-only IR queries
159+
│ ├── inspect/ # `ado-aw inspect` / `graph` / `trace` / `whatif` / `lint` / `catalog` — read-only IR queries
148160
│ │ ├── mod.rs # Module entry; public re-exports of every dispatcher
149161
│ │ ├── cli.rs # Dispatchers (`dispatch_inspect`, `dispatch_graph`, …) and option structs
150-
│ │ └── graph_query.rs # Text/DOT renderers for the resolved dependency graph
162+
│ │ ├── graph_query.rs # Text/DOT renderers for the resolved dependency graph
163+
│ │ ├── graph_deps.rs # `ado-aw graph deps`: upstream/downstream dependency traversal
164+
│ │ ├── graph_outputs.rs # `ado-aw graph outputs`: producer/consumer output-reference table
165+
│ │ ├── trace.rs # `ado-aw trace`: correlate audit telemetry with the local IR graph
166+
│ │ ├── whatif.rs # `ado-aw whatif`: static downstream skip classification for failures
167+
│ │ ├── lint.rs # `ado-aw lint`: structural workflow lint checks
168+
│ │ └── catalog.rs # `ado-aw catalog`: list in-tree registries (tools, runtimes, models, etc.)
151169
│ ├── detect.rs # Agentic pipeline detection — discovers compiled pipelines; used by all lifecycle commands
152170
│ ├── update_check.rs # Version update check — queries GitHub Releases and prints advisory when newer version is available
153171
│ ├── ndjson.rs # NDJSON parsing utilities

docs/cli.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,14 @@ Both `--all-repos` and `--source` route through `ado-aw`'s `discover_ado_aw_pipe
166166

167167
- `whatif <source> --fail <step-id-or-job-id> [--json]` - Statically classify downstream jobs that would be skipped, or would run anyway, if a step or job failed.
168168

169+
- `lint <source> [--json]` - Run structural lint checks over an agent source file without writing YAML.
170+
- `<source>` - Path to the agent markdown file.
171+
- `--json` - Emit lint findings as structured JSON instead of the human-readable report.
172+
173+
- `catalog [--kind <safe-outputs|runtimes|tools|engines|models>] [--json]` - List the compiler's in-tree registries for scripting or discovery.
174+
- `--kind <...>` - Restrict output to one category. When omitted, emits every category.
175+
- `--json` - Emit the catalog as structured JSON instead of the human-readable report.
176+
169177
### Hidden Build-Time Tools
170178

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

0 commit comments

Comments
 (0)