Skip to content

docs(site): fix trigger field names in creating-agents guide#703

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-trigger-syntax-in-creating-agents-077a00fe4164699c
May 22, 2026
Merged

docs(site): fix trigger field names in creating-agents guide#703
jamesadevine merged 1 commit into
mainfrom
docs/fix-trigger-syntax-in-creating-agents-077a00fe4164699c

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Summary

  • Fixes incorrect trigger key names in the "Add triggers" section of the Creating agent definition files guide.
  • The guide was using push: and pull_request: (GitHub Actions syntax) where the correct ado-aw front matter keys are pipeline: and pr:. Any reader who copied these examples verbatim would configure triggers that silently do nothing.

Changes

  • site/src/content/docs/guides/creating-agents.mdx:
    • Removed the invalid push: trigger section (no such key exists in ado-aw).
    • Added a pipeline: trigger section (pipeline completion trigger — the ado-aw equivalent).
    • Replaced all pull_request: occurrences with pr:.
    • Updated the combined-trigger example and the full "Put it together" example.
    • Added a short preamble naming all three supported trigger types so users know the full set upfront.

Accuracy checks

  • src/compile/types.rs OnConfig struct: fields are schedule, pipeline, pr — no push or pull_request field.
  • src/compile/common.rs generate_ci_trigger: CI trigger behavior is driven by presence of pipeline or schedule, never a push key.
  • site/src/content/docs/reference/front-matter.mdx canonical examples use on.pr: and on.pipeline: consistently.

Validation

  • cd site && npm ci && npm run build — 29 pages built, all internal links valid.

Created by the docs-writer workflow.

Generated by Docs Writer · ● 21.2M ·

Replace GitHub Actions-style push:/pull_request: with the correct
ado-aw keys (pr: and pipeline:). The guide was teaching readers
invalid front matter that would silently produce no triggers.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request May 22, 2026
@jamesadevine jamesadevine marked this pull request as ready for review May 22, 2026 18:19
@jamesadevine jamesadevine merged commit 508de34 into main May 22, 2026
@jamesadevine jamesadevine deleted the docs/fix-trigger-syntax-in-creating-agents-077a00fe4164699c branch May 22, 2026 18:19
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