docs: fix documentation drift — on.pr trigger missing from workflow creation prompt#581
Merged
jamesadevine merged 1 commit intoMay 17, 2026
Conversation
…workflow.md Step 11 only documented on.pipeline triggers. The on.pr trigger is fully implemented (PrTriggerConfig with branches/paths/filters) and documented in docs/front-matter.md, but was entirely absent from the workflow creation prompt that agents use. - Rename Step 11 to 'Triggers (optional)' to cover both trigger types - Add on.pr section with full example (branches, paths, runtime filters) - Add explanation of how on.pr generates native ADO pr: block + gate step - Fix 'PR-Triggered Code Review' common pattern to actually use on.pr (it previously used on.pipeline, which contradicted the pattern name) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit compared docs against the actual codebase, checking CLI commands, front-matter fields, template markers, safe output tools, and the workflow authoring prompt.
Findings
prompts/create-ado-agentic-workflow.mdon.pipelinetriggers —on.prtrigger was completely absent, despite being fully implemented and documented indocs/front-matter.mdprompts/create-ado-agentic-workflow.mdon.pipeline(pipeline-completion trigger), contradicting the pattern nameprompts/create-ado-agentic-workflow.mdDetails
Missing
on.prtrigger documentation (prompts/create-ado-agentic-workflow.md)PrTriggerConfiginsrc/compile/types.rssupports three fields:branches,paths, andfilters. Thefiltersfield compiles to a runtime gate step in the Setup job (same ason.pipeline.filters). This is fully documented indocs/front-matter.mdanddocs/filter-ir.md, but Step 11 of the creation prompt only coveredon.pipeline, so agents using this prompt would never know to useon.prwhen a user wants a PR-triggered workflow."PR-Triggered Code Review" pattern using wrong trigger
The Common Patterns section had a pattern titled "PR-Triggered Code Review" that used
on.pipeline(triggered when a CI build pipeline completes). The corrected pattern now useson.prwithfilters.draft: false, which is the natural trigger for a PR code review agent.Applied Fixes
on.prsubsection with full example coveringbranches,paths, and allfiltersoptionson.prgenerates the native ADOpr:block frombranches/pathsand a gate step fromfilterson.prwith appropriate filtersOther Findings (no action needed)
The following areas checked out as accurate:
AGENTS.md): directory tree matches actual source files exactlydocs/cli.md): all 7 subcommands documented with correct flags and defaultsdocs/template-markers.md): all markers in all 4 base templates documenteddocs/front-matter.md):FrontMatterstruct fields all documented;env:correctly marked as "not yet implemented"docs/safe-outputs.md,README.md): all tools insrc/safeoutputs/documenteddocs/network.md): matchesCORE_ALLOWED_HOSTSinsrc/allowed_hosts.rsclaude-opus-4.7matchesDEFAULT_COPILOT_MODELconstant insrc/engine.rsvmImage: ubuntu-22.04matches compiler defaultThis pull request was created by the automated documentation freshness check.