Skip to content

docs: document reserved dependsOn/condition parameter names for target job/stage #2190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-actions wants to merge 1 commit into from
Closed

docs: document reserved dependsOn/condition parameter names for target job/stage #2190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,12 @@ When `tools.cache-memory` is configured, the compiler automatically injects a `c
- Creates an empty memory directory so the agent starts fresh

If you define your own `clearMemory` parameter in the front matter, the auto-injected one is suppressed — your definition takes precedence.

### Reserved names on `target: job` / `target: stage`

On these two targets the compiler auto-injects its own `dependsOn` and
`condition` template parameters (see [`docs/targets.md`](targets.md)) so
callers can wire in external ordering at the `template:` invocation site.
Declaring a front-matter `parameters:` entry named `dependsOn` or `condition`
on `target: job` or `target: stage` is therefore a **compile-time error** —
rename the parameter or switch targets.
6 changes: 6 additions & 0 deletions docs/targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ stages:
- The `condition` parameter is ANDed into the agent job's existing internal
condition (PR gate, pipeline gate, etc.). Empty default preserves ADO's
native `succeeded()` behaviour.
- `dependsOn` and `condition` are reserved parameter names on `target: job`.
Declaring a front-matter `parameters:` entry with either name is a
**compile-time error** — rename the parameter or drop `target: job`.
- Triggers (`on:`) are ignored with a warning (the parent pipeline controls triggers).
- If the agent declares additional repositories via `repos:`, add them to the
parent pipeline's `resources:` block (documented in the generated file header).
Expand Down Expand Up @@ -136,6 +139,9 @@ stages:
behaviour.
- The `dependsOn` parameter is typed `object`, matching ADO's native
`dependsOn:` semantics (accepts a single string or a list).
- `dependsOn` and `condition` are reserved parameter names on `target: stage`,
same as `target: job` — a front-matter `parameters:` entry with either name
is a **compile-time error**.
- Same 3-job chain, job-name prefixing, and pool handling as `target: job`.
- Triggers (`on:`) are ignored with a warning.
- If the agent declares additional repositories via `repos:`, add them to the
Expand Down