Skip to content

πŸ“ Documentation drift detected β€” missing configure command + undocumented source filesΒ #116

@github-actions

Description

@github-actions

Documentation Freshness Audit

The weekly documentation audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree src/configure.rs and src/detect.rs are not listed AGENTS.md lines 21–61
CLI Commands configure subcommand is entirely absent AGENTS.md lines 708–733, README.md lines 382–390
CLI Commands compile (path) documents path as required, but it is optional with auto-discovery AGENTS.md line 716

Details

1. Missing source files in architecture tree

AGENTS.md lists the project source tree, but two files that exist on disk are absent:

  • src/configure.rs β€” implements the configure CLI command (detects agentic pipelines and updates GITHUB_TOKEN on their ADO build definitions)
  • src/detect.rs β€” pipeline auto-detection logic used by both configure and compile

2. Undocumented configure subcommand

src/main.rs defines a Configure variant in the Commands enum (line 84–106), but it does not appear anywhere in the CLI Commands section of AGENTS.md or in the README.md command listing. The command has the following flags:

configure
  --token          The new GITHUB_TOKEN value (defaults to $GITHUB_TOKEN env var)
  --org            Override ADO organization URL (inferred from git remote by default)
  --project        Override ADO project name (inferred from git remote by default)
  --pat            PAT for ADO API auth (prefer $AZURE_DEVOPS_EXT_PAT env var)
  --path           Path to repository root (defaults to current directory)
  --dry-run        Preview changes without applying them
  --definition-ids Explicit pipeline definition IDs to update (comma-separated)

3. compile (path) β€” optional path not reflected in docs

AGENTS.md documents the command as compile (path), implying the path is required. In src/main.rs (lines 33–40), path is Option(String) with the comment: "If omitted, auto-discovers and recompiles all existing agentic pipelines in the current directory." The docs should reflect this optional behavior.

Suggested Fixes

  • Add src/configure.rs and src/detect.rs (with short descriptions) to the architecture tree in AGENTS.md
  • Document the configure subcommand in the CLI Commands section of AGENTS.md with all its flags and a short description of its purpose
  • Add configure to the command listing in README.md
  • Update compile (path) in AGENTS.md to compile [path] and note the auto-discovery behavior when path is omitted

This issue was created by the automated documentation freshness check.

Generated by Documentation Freshness Check Β· β—·

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions