Skip to content

docs: fix documentation drift — ado-script bundle inventory and schedule syntax #1175

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
ado-script bundles "Today it produces four bundles" — actually eleven docs/ado-script.md
ado-script workspace layout Directory tree missing exec-context-ci-push/, exec-context-workitem/, exec-context-schedule/, exec-context-pr-checks/, exec-context-repo/ source dirs and corresponding .js outputs docs/ado-script.md
ado-script release asset listing Zip listing missing 5 new bundles docs/ado-script.md
AGENTS.md architecture tree scripts/ado-script/src/ showed only 4 dirs (gate, import, exec-context-pr, exec-context-pr-synth, shared); 6 more exist on disk AGENTS.md
AGENTS.md Technology Stack Listed only the original 4 bundles; referenced stale bundle names AGENTS.md
AGENTS.md docs index ado-script.md entry listed only 4 bundles AGENTS.md
Schedule syntax docs/schedule-syntax.md omits valid accepted forms: every N hours long form, every 1h, minute aliases (min, mins, minute), and day/week singular forms (day, d, week, w) docs/schedule-syntax.md

Details

docs/ado-script.md: The intro said "Today it produces four bundles" but scripts/ado-script/package.json defines 11 build:* scripts and src/compile/extensions/ado_script.rs exports 9 named path constants for bundles. Five bundles added after the exec-context-manual/pipeline pair were never added to the docs: exec-context-ci-push.js, exec-context-workitem.js, exec-context-schedule.js, exec-context-pr-checks.js, and exec-context-repo.js. The workspace layout tree and the release-zip listing also only covered the first six bundles.

AGENTS.md: The architecture tree under scripts/ado-script/src/ listed only 5 entries (gate, import, exec-context-pr, exec-context-pr-synth, shared). Seven additional source directories exist on disk. The Technology Stack bullet and the docs-index entry for ado-script.md both referenced only the original 4-bundle description.

docs/schedule-syntax.md: The fuzzy-schedule parser (src/fuzzy_schedule.rs) accepts several natural synonyms that are absent from the docs: the long form every 2 hours (with space + word), every 1h as an alternative to hourly, singular/abbreviated minute units (min, mins, minute), and singular/abbreviated day/week units (day, d, week, w). These were confirmed valid by reading the parser source.

Applied Fixes

  • docs/ado-script.md: updated bundle count (four → eleven), added descriptions for the 5 new bundles, expanded workspace layout tree, updated release asset listing
  • AGENTS.md: expanded scripts/ado-script/src/ tree to all 11 source directories, updated Technology Stack bullet and docs-index entry for ado-script.md
  • docs/schedule-syntax.md: documented previously undocumented but valid syntax alternatives for hourly (every 1h, every N hours), minute (min, mins, minute), and day/week (day, week, singular) forms

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


Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files
  • AGENTS.md

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually
# Download the patch from the workflow run
gh run download 28043529878 -n agent -D /tmp/agent-28043529878

# Create a new branch
git checkout -b docs/fix-ado-script-bundle-drift-96cdc627bf7ecf57 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-28043529878/aw-docs-fix-ado-script-bundle-drift.patch

# Push the branch and create the pull request
git push origin docs/fix-ado-script-bundle-drift-96cdc627bf7ecf57
gh pr create --title 'docs: fix documentation drift — ado-script bundle inventory and schedule syntax' --base main --head docs/fix-ado-script-bundle-drift-96cdc627bf7ecf57 --repo githubnext/ado-aw

Warning

Firewall blocked 2 domains

The following domains were blocked by the firewall during workflow execution:

  • spsprodeus21.vssps.visualstudio.com
  • spsprodweu4.vssps.visualstudio.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "spsprodeus21.vssps.visualstudio.com"
    - "spsprodweu4.vssps.visualstudio.com"

See Network Configuration for more information.

Generated by Documentation Freshness Check · 1.9K AIC · ⌖ 32.5 AIC · ⊞ 36.2K ·

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