Skip to content

docs: fix architecture tree — add missing source files #650

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit compared the AGENTS.md architecture tree against the actual source files and found three source files that exist in the codebase but were missing from the documented tree.

Findings

Area Issue File(s)
AGENTS.md architecture src/compile/extensions/ado_aw_marker.rs not listed in extensions/ AGENTS.md
AGENTS.md architecture src/ado/discovery.rs not listed in ado/ directory AGENTS.md
AGENTS.md architecture src/update_check.rs not listed in src/ AGENTS.md

Details

src/compile/extensions/ado_aw_marker.rs — The always-on AdoAwMarkerExtension that emits the # ado-aw-meta(redacted) JSON marker step in every compiled pipeline. This is a critical extension: src/detect.rsparses these markers to discover and match compiled pipelines for all lifecycle commands. It was registered inextensions/mod.rsasExtension::AdoAwMarker` but omitted from the documentation tree.

src/ado/discovery.rs — The Preview-driven pipeline discovery module that powers the --all-repos and --source flags on secrets set/list/delete. This module calls ADO's Pipeline Preview API per definition and scans the expanded YAML for ado-aw-marker steps. It is a substantial module mentioned in the project but absent from the tree.

src/update_check.rs — A background task spawned on every CLI invocation that checks GitHub Releases for a newer version of ado-aw and prints an advisory if one is found.

Applied Fixes

  • Added ado_aw_marker.rs to the extensions/ listing in the AGENTS.md architecture tree
  • Expanded the ado/ directory entry to show both mod.rs and discovery.rs
  • Added update_check.rs to the root src/ 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.2M ·

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