Skip to content

docs: document missing pipeline filter options (branch, build-reason, expression)#530

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-pipeline-filters-documentation-1fc5b8e0d52f59fd
May 13, 2026
Merged

docs: document missing pipeline filter options (branch, build-reason, expression)#530
jamesadevine merged 1 commit into
mainfrom
docs/fix-pipeline-filters-documentation-1fc5b8e0d52f59fd

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
Pipeline trigger filters branch, build-reason, and expression filter options are fully implemented in PipelineFilters but absent from user-facing examples docs/front-matter.md, prompts/create-ado-agentic-workflow.md

Details

The on.pipeline.filters YAML examples in both user-facing docs only showed source-pipeline and time-window:

filters:
  source-pipeline: "Build*"
  time-window:
    start: "09:00"
    end: "17:00"

Three additional fields on PipelineFilters (src/compile/types.rs) are fully implemented and lowered by lower_pipeline_filters() in src/compile/filter_ir.rs, and are referenced in the developer-focused docs/filter-ir.md — but were absent from user-facing examples:

  • branchGlobMatch on $(Build.SourceBranch) (TriggeringBranch fact). Useful for filtering pipeline-completion triggers to specific branches of the upstream pipeline.
  • build-reasoninclude/exclude by build reason (same semantics as the PR filter variant). Already validated at compile time for conflicting include/exclude.
  • expression — raw ADO condition escape hatch (same as pr.filters.expression, already documented in the Expression Escape Hatch section of front-matter.md).

An AI agent authoring a pipeline using the prompts/create-ado-agentic-workflow.md prompt would have no way to discover these filter options.

Applied Fixes

  • Added branch, build-reason, and expression to the on.pipeline.filters YAML example in docs/front-matter.md
  • Added branch, build-reason, and expression to Step 11's pipeline trigger filters example in prompts/create-ado-agentic-workflow.md
  • Clarified in the filter validation table that build-reason conflict detection applies to both PR filters and pipeline filters

This pull request was created by the automated documentation freshness check.

Generated by Documentation Freshness Check · ● 6.1M ·

… expression)

The on.pipeline.filters section in docs/front-matter.md and
prompts/create-ado-agentic-workflow.md only showed source-pipeline and
time-window as filter options. Three additional pipeline filter fields are
fully implemented in PipelineFilters (src/compile/types.rs) and their
lowering is documented in docs/filter-ir.md, but were absent from
user-facing documentation:

- branch: glob match on triggering branch (Build.SourceBranch)
- build-reason: include/exclude by build reason (same as PR filters)
- expression: raw ADO condition escape hatch

Also clarifies in the filter validation table that build-reason validation
applies to both PR filters and pipeline filters.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine marked this pull request as ready for review May 13, 2026 22:41
@jamesadevine jamesadevine merged commit f29f1d5 into main May 13, 2026
@jamesadevine jamesadevine deleted the docs/fix-pipeline-filters-documentation-1fc5b8e0d52f59fd branch May 13, 2026 22:41
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