Skip to content

docs(site): fix job/stage targets — dependsOn and condition must be parameters#830

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-targets-template-parameters-97688fc910cfefe0
Jun 2, 2026
Merged

docs(site): fix job/stage targets — dependsOn and condition must be parameters#830
jamesadevine merged 1 commit into
mainfrom
docs/fix-targets-template-parameters-97688fc910cfefe0

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Jun 2, 2026

Summary

  • Fixes an accuracy bug in targets.mdx: the stage usage example showed bare dependsOn: and condition: keys on the - template: line, which ADO's YAML parser rejects. The prose even claimed "ADO natively supports dependsOn and condition at the template call site — no template parameters are needed", which is wrong.
  • Both job and stage usage examples now show the correct parameters: wrapper.
  • Added Notes sections with key caveats: ADO template schema constraints, the dependsOn list requirement for agents with a Setup job, and condition ANDing behaviour.
  • Added a second <Aside> callout in the Template Target Considerations section to reinforce the parameters: requirement for users who scan to the bottom.
  • Fixed -> arrow inconsistency in standalone and 1es descriptions.

Changes

  • site/src/content/docs/reference/targets.mdx: fixed stage usage example; updated job usage to show parameters:; added Notes sections; fixed arrow characters; added Aside callout.

Accuracy checks

  • Usage examples and notes verified against docs/targets.md (canonical source of truth).
  • ADO template call-site schema constraint (template: + parameters: only) confirmed in docs/targets.md notes for both job and stage targets.
  • Pool default (vmImage: ubuntu-22.04) confirmed in docs/targets.md.

Validation

  • cd site && npm ci && npm run build
  • Build succeeded: 33 page(s) built
  • Starlight links validator: "All internal links are valid."

Created by the docs-writer workflow.

Generated by Docs Writer · sonnet46 2.4M ·

…arameters

ADO's template call-site schema only allows template: and parameters:
as top-level keys. The previous stage usage example showed bare
dependsOn: and condition: keys, and the prose claimed ADO natively
supports them — both incorrect. Fixed both targets to show the correct
parameters: wrapper, added Notes sections with ADO schema constraints,
pool default, and Setup-job list requirement for job target. Added a
second Aside callout reinforcing the parameters requirement.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request Jun 2, 2026
@jamesadevine jamesadevine marked this pull request as ready for review June 2, 2026 23:09
@jamesadevine jamesadevine merged commit ba615af into main Jun 2, 2026
@jamesadevine jamesadevine deleted the docs/fix-targets-template-parameters-97688fc910cfefe0 branch June 2, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant