Skip to content

docs(site): fix pool default and add missing pipeline filter fields in front-matter reference#644

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-front-matter-pool-pipeline-filters-9a5d62bb6dcfb9f0
May 19, 2026
Merged

docs(site): fix pool default and add missing pipeline filter fields in front-matter reference#644
jamesadevine merged 1 commit into
mainfrom
docs/fix-front-matter-pool-pipeline-filters-9a5d62bb6dcfb9f0

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • The pool example in the Agent File Format reference now correctly shows vmImage: ubuntu-22.04 as the non-1ES default, matching code behavior. The previous example used a bare 1ES pool name string which misled users into thinking that was the default Microsoft-hosted pool.
  • The pipeline.filters example now shows all five supported fields (source-pipeline, branch, time-window, build-reason, expression). Three were missing even though the prose sections ("Expression Escape Hatch", "Filter Validation") already referenced them.

Changes

  • site/src/content/docs/reference/front-matter.mdx — two targeted corrections to the comprehensive front matter example

Accuracy checks

  • Pool default: src/compile/types.rs PoolConfig::default() returns PoolConfigFull { vm_image: Some("ubuntu-22.04") } — confirmed the default is Microsoft-hosted vmImage: ubuntu-22.04, not the 1ES pool name
  • Pool object fields: PoolConfigFull struct has name, vmImage, os — the old example only showed name + os and omitted vmImage entirely
  • Pipeline filters: PipelineFilters struct (types.rs:1093–1109) has time_window, source_pipeline, branch, build_reason, expression — all five, only two were in the example
  • Source-of-truth docs: docs/front-matter.md shows all three missing fields (branch, build-reason, expression) in the pipeline filters block

Validation

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

Created by the docs-writer workflow.

Generated by Docs Writer · ● 2.8M ·

…n front-matter reference

- Correct the pool example: replace stale 'AZS-1ES-L-MMS-ubuntu-22.04' string
  default with accurate vmImage: ubuntu-22.04 (Microsoft-hosted) form, and add
  commented alternatives for self-hosted string, self-hosted object, and 1ES.
- Add branch, build-reason, and expression to the pipeline.filters example; all
  three are present in PipelineFilters struct (types.rs) and the repo docs but
  were absent from the site page, while the 'Expression Escape Hatch' and
  'Filter Validation' prose sections already referenced them.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine marked this pull request as ready for review May 19, 2026 10:11
@jamesadevine jamesadevine merged commit c9185c6 into main May 19, 2026
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