Skip to content

docs: fix documentation drift — pool defaults and codemod registry #540

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Pool defaults Pool default shown as AZS-1ES-L-MMS-ubuntu-22.04 for all targets; actual standalone default is vmImage: ubuntu-latest README.md, prompts/create-ado-agentic-workflow.md
Codemod registry 0002_pool_object_form.rs exists in src/compile/codemods/ but is absent from architecture and file-layout docs AGENTS.md, docs/codemods.md

Details

Pool default mismatch (critical — affects agent-authored pipelines)

src/compile/common.rs defines two separate defaults:

pub const DEFAULT_ONEES_POOL: &str = "AZS-1ES-L-MMS-ubuntu-22.04";
pub const DEFAULT_VM_IMAGE_POOL: &str = "ubuntu-latest";

The standalone target resolves to vmImage: ubuntu-latest when no pool: is set; the 1ES target resolves to name: AZS-1ES-L-MMS-ubuntu-22.04.

  • README.md (line 241): listed the default as AZS-1ES-L-MMS-ubuntu-22.04 regardless of target.
  • prompts/create-ado-agentic-workflow.md Step 6: stated "Defaults to AZS-1ES-L-MMS-ubuntu-22.04" without distinguishing targets. This directly causes AI agents to generate incorrect pool configuration for standalone pipelines.

Missing codemod in architecture/file-layout docs

src/compile/codemods/0002_pool_object_form.rs is registered in the CODEMODS slice in mod.rs but was not reflected in:

  • The AGENTS.md architecture directory tree (codemods section)
  • The file layout listing in docs/codemods.md

Applied Fixes

  • README.md: Updated pool field default to reflect both targets: vmImage: ubuntu-latest (standalone) / AZS-1ES-L-MMS-ubuntu-22.04 (1ES)
  • prompts/create-ado-agentic-workflow.md: Updated Step 6 to document the correct target-dependent defaults with examples for both standalone (vmImage) and 1ES (name+os) forms
  • AGENTS.md: Added 0002_pool_object_form.rs to the codemods directory tree in the architecture section
  • docs/codemods.md: Added 0002_pool_object_form.rs to the file layout listing

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


Warning

Protected Files

This was originally intended as a pull request, but the patch modifies protected files. These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.

Click here to create the pull request once you have reviewed the changes

Protected files
  • AGENTS.md

To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.

Generated by Documentation Freshness Check · ● 3.1M ·

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions