Skip to content

Commit 15fdedd

Browse files
docs: fix architecture tree, network domain attribution, and workspace defaults reference (#353)
* Initial plan * docs: fix architecture tree, network domain attribution, and workspace defaults reference Agent-Logs-Url: https://github.com/githubnext/ado-aw/sessions/30b5ebbc-f42c-4ff2-bc93-d56f6f5593a4 Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
1 parent a8b00a5 commit 15fdedd

3 files changed

Lines changed: 20 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ Every compiled pipeline runs as three sequential jobs:
114114
│ ├── mod.rs
115115
│ ├── extension.rs # CompilerExtension impl (compile-time)
116116
│ └── execute.rs # Stage 3 runtime (validate/copy)
117+
├── ado-aw-derive/ # Proc-macro crate: #[derive(SanitizeConfig)], #[derive(SanitizeContent)]
117118
├── examples/ # Example agent definitions
118119
├── tests/ # Integration tests and fixtures
119120
├── docs/ # Per-concept reference documentation (see index below)

docs/front-matter.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ schedule: daily around 14:00 # Fuzzy schedule syntax - see docs/schedule-syntax.
2222
# branches:
2323
# - main
2424
# - release/*
25-
workspace: repo # Optional: "root", "repo" (alias: "self"), or a checked-out repository alias. If not specified, defaults based on checkout configuration (see below).
25+
workspace: repo # Optional: "root", "repo" (alias: "self"), or a checked-out repository alias. If not specified, defaults to "root" when no additional repositories are listed in `checkout:`, and to "repo" when one or more additional repos are checked out. See "Workspace Defaults" below.
2626
pool: AZS-1ES-L-MMS-ubuntu-22.04 # Agent pool name (string format). Defaults to AZS-1ES-L-MMS-ubuntu-22.04.
2727
# pool: # Alternative object format (required for 1ES if specifying os)
2828
# name: AZS-1ES-L-MMS-ubuntu-22.04
@@ -111,3 +111,19 @@ parameters: # optional ADO runtime parameters (surfaced in UI
111111

112112
Build the project and run all tests...
113113
```
114+
115+
## Workspace Defaults
116+
117+
The `workspace:` field controls which directory the agent runs in. When it is
118+
not set explicitly, the compiler chooses a default based on the `checkout:`
119+
list:
120+
121+
- If `checkout:` is empty (i.e. only the pipeline's own repository is checked
122+
out via the implicit `self`), `workspace:` defaults to **`root`** — the
123+
agent runs in the pipeline's working directory root.
124+
- If `checkout:` lists one or more additional repository aliases,
125+
`workspace:` defaults to **`repo`** — the agent runs inside the first
126+
checked-out repository's directory.
127+
128+
Set `workspace:` explicitly to `root`, `repo` (alias `self`), or a specific
129+
checked-out repository alias to override this behavior.

docs/network.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `ado-aw` compiler binary is distributed via [GitHub Releases](https://github
1010

1111
## Default Allowed Domains
1212

13-
The following domains are always allowed (defined in `allowed_hosts.rs`):
13+
The following domains are always allowed. Most are defined in `CORE_ALLOWED_HOSTS` in `allowed_hosts.rs`; `host.docker.internal` is the exception — it is added by the standalone compiler in `generate_allowed_domains` (`src/compile/common.rs`) because standalone pipelines always use MCPG, which needs host access from the AWF container:
1414

1515
| Host Pattern | Purpose |
1616
|-------------|---------|
@@ -46,7 +46,7 @@ The following domains are always allowed (defined in `allowed_hosts.rs`):
4646
| `dc.services.visualstudio.com` | Visual Studio telemetry |
4747
| `rt.services.visualstudio.com` | Visual Studio runtime telemetry |
4848
| `config.edge.skype.com` | Configuration |
49-
| `host.docker.internal` | MCP Gateway (MCPG) on host |
49+
| `host.docker.internal` | MCP Gateway (MCPG) on host — added by the standalone compiler, not part of `CORE_ALLOWED_HOSTS` |
5050

5151
## Adding Additional Hosts
5252

0 commit comments

Comments
 (0)