Skip to content

docs: fix documentation drift — gate.js arch entry and missing weekly-between schedule #643

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit compared documentation against the codebase and found the following inconsistencies:

Findings

Area Issue File(s)
Architecture tree scripts/gate.js listed as a committed file — does not exist in the repo AGENTS.md
Schedule syntax prompt weekly on <weekday> between <start> and <end> syntax missing from frequency table prompts/create-ado-agentic-workflow.md
Schedule syntax README weekly between example absent from quick-reference schedule block README.md

Details

scripts/gate.js in AGENTS.md architecture tree

AGENTS.md listed │ └── gate.js # Bundled gate evaluator ... as if a file scripts/gate.js were committed to the repository. It is not. The gate evaluator TypeScript source lives in scripts/ado-script/src/gate/, builds to scripts/ado-script/dist/gate/index.js (gitignored), and is packaged as ado-script.zip for release — confirmed by the release workflow (.github/workflows/release.yml) and the runtime path constant GATE_EVAL_PATH = "/tmp/ado-aw-scripts/ado-script/dist/gate/index.js" in src/compile/extensions/trigger_filters.rs.

Missing weekly on <weekday> between schedule syntax

fuzzy_schedule.rs supports weekly on <weekday> between <start> and <end> (handled in parse_weekly_schedule() via the TimeConstraint::Between arm), and the syntax is documented in docs/schedule-syntax.md. However, neither prompts/create-ado-agentic-workflow.md (the primary agent prompt guide) nor the README quick-reference schedule block included this form, making it invisible to agents authoring new workflows.

Applied Fixes

  • AGENTS.md: Replace the two-line scripts/ado-script/ + scripts/gate.js tree entry with a single accurate entry describing scripts/ado-script/ as the TypeScript workspace that builds ado-script.zip
  • prompts/create-ado-agentic-workflow.md: Add weekly on wednesday between 9:00 and 12:00 row to the Step 3 schedule frequency table
  • README.md: Add weekly on friday between 9:00 and 17:00 example to the schedule quick-reference block

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 · ● 9.9M ·

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