Skip to content

docs: fix ado-script bundle documentation drift #1155

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
ado-script bundles States "Today it produces four bundles" but the build system produces eleven docs/ado-script.md
ado-script workspace layout Tree missing 5 new entry point dirs (exec-context-ci-push/, -workitem/, -schedule/, -pr-checks/, -repo/) and their .js outputs docs/ado-script.md
ado-script release zip description Lists only 6 of the 11 bundles packaged into ado-script.zip docs/ado-script.md
import.js "ships in same zip" prose Lists only 5 sibling bundles instead of all 10 docs/ado-script.md
Architecture tree ado-script/src/ shows only 2 entry point dirs; missing exec-context-manual/, exec-context-pipeline/, and 5 more AGENTS.md
Technology stack Describes only "gate evaluator, runtime import resolver, PR-context precompute, and synthetic-PR resolver" — missing 7 bundles AGENTS.md
Docs index Lists only 4 bundle names for the ado-script.md reference AGENTS.md
Contributor reference Lists only 4 bundles in the ado-script.md cross-reference README.md

Details

The scripts/ado-script workspace build system (package.json) now builds eleven ncc bundles:

Bundle Purpose
gate.js Trigger-filter gate evaluator (Setup job)
import.js Runtime prompt resolver (Agent job)
exec-context-pr.js PR merge-base + SHA precompute
exec-context-pr-synth.js Synthetic-PR promotion (CI → PR semantics)
exec-context-manual.js Manual-run parameter context
exec-context-pipeline.js Upstream pipeline-completion context
exec-context-ci-push.js ⬅ new "Since last green build" diff context for CI/push
exec-context-workitem.js ⬅ new PR-linked work-item context
exec-context-schedule.js ⬅ new "Since last successful run" diff context for scheduled builds
exec-context-pr-checks.js ⬅ new PR Build Validation check results
exec-context-repo.js ⬅ new Repository identity (branch, SHA, last-release-tag)

The five new bundles correspond to the five new src/exec-context-*/ source directories and their exec_context/*.rs contributors in the Rust compiler — all already documented in docs/execution-context.md, but the ado-script.md workspace reference and AGENTS.md architecture tree were never updated.

Applied Fixes

  • docs/ado-script.md: correct bundle count (four → eleven); add 5 missing bundles to intro list; expand workspace layout tree with all 5 new entry-point dirs and their .js outputs; update release workflow description to list all 11 bundles; update import.js "ships in same zip" prose
  • AGENTS.md: expand ado-script/src/ tree to include all 9 exec-context dirs; update technology stack bullet; update docs index entry
  • README.md: update ado-script.md cross-reference from 4 named bundles to a compact description of all 11

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
  • README.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 27973275353 -n agent -D /tmp/agent-27973275353

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

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27973275353/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-2360f1630e8e8d4a
gh pr create --title 'docs: fix ado-script bundle documentation drift' --base main --head docs/fix-ado-script-bundle-drift-2360f1630e8e8d4a --repo githubnext/ado-aw

Generated by Documentation Freshness Check · 1.8K AIC · ⌖ 32.1 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