docs: fix documentation drift — pipeline trigger cancel step inaccuracy#523
Merged
jamesadevine merged 1 commit intoMay 13, 2026
Merged
Conversation
The Step 11 pipeline trigger section incorrectly stated that setting `on.pipeline` automatically includes "a step to cancel previous queued builds". No such step exists. The self-cancellation gate step is only generated when `on.pipeline.filters` is configured with actual filter checks (via the TriggerFiltersExtension in src/compile/extensions/trigger_filters.rs). Fix the description to accurately describe the behavior: trigger: none and pr: none are generated automatically, and a gate step with self-cancellation is only added when filters: are configured. Also add a complete filters: example to the pipeline trigger YAML block so agents know filters are available under on.pipeline. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jamesadevine
deleted the
docs/fix-pipeline-trigger-doc-drift-3ff37798b5f6d722
branch
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 found the following inconsistency between code and documentation:
Findings
on.pipelineis set — no such step exists in the compilerprompts/create-ado-agentic-workflow.mdDetails
Step 11 — Pipeline Triggers in
prompts/create-ado-agentic-workflow.mdcontained this inaccurate sentence:What the code actually does (
src/compile/extensions/trigger_filters.rs):trigger: noneandpr: noneare generated automatically whenon.pipelineis set — ✅ correcton.pipeline.filtersis configured with at least one filter check — ❌ the old text implied it was always generatedThe
TriggerFiltersExtension::setup_steps()method returns an emptyVec(no steps) when there are no filter checks. No "cancel previous queued builds" step of any kind is generated from a plainon.pipelineconfiguration withoutfilters:.Additionally, the
filters:sub-option was entirely absent from the Step 11 YAML example, leaving agents with no guidance on how to use pipeline filters.Applied Fixes
filters:are configuredfilters:sub-object example to the Step 11 YAML block so agents know pipeline filters are availableThis pull request was created by the automated documentation freshness check.