Skip to content

Commit 556ee7e

Browse files
docs: fix template-markers.md drift — aliases and schedule variants (#725)
1 parent c2cb863 commit 556ee7e

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

docs/template-markers.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ Examples of fuzzy schedule → cron conversion:
7676
- `weekly on monday` → Monday at scattered time (e.g., `"43 5 * * 1"`)
7777
- `every 2h` → every 2 hours at scattered minute (e.g., `"53 */2 * * *"`)
7878
- `bi-weekly` → every 14 days (e.g., `"43 5 */14 * *"`)
79+
- `tri-weekly` → every 21 days (e.g., `"43 5 */21 * *"`)
80+
- `every 3 days` → every 3 days (e.g., `"43 5 */3 * *"`)
81+
- `every 2 weeks` → every 14 days (e.g., `"43 5 */14 * *"`)
82+
83+
See [`docs/schedule-syntax.md`](schedule-syntax.md) for the full schedule syntax reference.
7984

8085
## {{ checkout_self }}
8186

@@ -102,6 +107,8 @@ Should be replaced with the human-readable name from the front matter
102107
no quoting or escaping — front-matter `name` values are free-form and
103108
have not been validated against YAML scalar rules.
104109

110+
> **Alias:** `{{ agent }}` is registered as a backward-compatible alias for `{{ agent_name }}` and expands to the same unescaped name value. The same safety caveat applies — only safe in non-YAML positions.
111+
105112
> ⚠️ This marker is only safe inside a position that is **not parsed as
106113
> YAML** (currently only `src/data/threat-analysis.md`, which is a
107114
> markdown body). YAML positions inside the generated pipelines use
@@ -159,6 +166,8 @@ so the macro passes through untouched.
159166
Used in `src/data/base.yml` and `src/data/1es-base.yml` only. The
160167
job- and stage-level templates don't emit a top-level pipeline name.
161168

169+
> **Alias:** `{{ pipeline_name }}` is registered as a backward-compatible alias for `{{ pipeline_agent_name }}` and expands to the same value.
170+
162171
## {{ engine_install_steps }}
163172

164173
Should be replaced with engine-specific pipeline steps to install the engine binary. Generated by `Engine::install_steps()`. The install strategy is **target-aware**:
@@ -311,6 +320,8 @@ workspace: exp23-a7-nw # Resolves to $(Build.SourcesDirectory)/exp23-a7-nw
311320

312321
This is used for the `workingDirectory` property of the copilot task.
313322

323+
> **Alias:** `{{ workspace }}` is registered as a backward-compatible alias for `{{ working_directory }}` and expands to the same value. Prefer `{{ working_directory }}` in new templates. For paths that must always resolve to the trigger repo (not the agent workspace), use [`{{ trigger_repo_directory }}`](#-trigger_repo_directory-) instead.
324+
314325
## {{ source_path }}
315326

316327
Should be replaced with the path to the agent markdown source file for Stage 3 execution. The path is anchored at the **trigger ("self") repository** via `{{ trigger_repo_directory }}` (see below), independent of the user's `workspace:` setting, and mirrors the relative path used at compile time:
@@ -498,7 +509,7 @@ The threat analysis prompt instructs the security analysis agent to check for:
498509

499510
## {{ agent_description }}
500511

501-
Should be replaced with the description field from the front matter. This is used in display contexts and the threat analysis prompt template.
512+
Should be replaced with the description field from the front matter. This is used in the threat analysis prompt template (`src/data/threat-analysis.md`) via `{{ threat_analysis_prompt }}`. It is **not** used in any pipeline YAML template (`base.yml`, `1es-base.yml`, `job-base.yml`, `stage-base.yml`) directly.
502513

503514
## {{ acquire_ado_token }}
504515

0 commit comments

Comments
 (0)