Skip to content

docs: fix documentation drift — add exec-context-pr.js to README ado-script bundle list #907

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
README — Compiler internals section docs/ado-script.md description lists only gate.js, import.js, omitting exec-context-pr.js README.md

Details

The README documentation section ("Compiler internals & operations") describes docs/ado-script.md as:

scripts/ado-script/ workspace (bundled TypeScript runtime helpers: gate.js, import.js).

The exec-context-pr.js bundle was added as part of the execution-context feature (issue #860). It is the PR-context precompute script that stages aw-context/pr/base.sha and aw-context/pr/head.sha for PR-triggered pipelines.

Both AGENTS.md and docs/ado-script.md already correctly list all three bundles (gate.js, import.js, exec-context-pr.js). README.md was not updated when exec-context-pr.js was introduced.

Evidence:

  • AGENTS.md lines 285–286: correctly lists all three
  • docs/ado-script.md: correctly documents all three bundles
  • scripts/ado-script/src/exec-context-pr/ directory exists with full source

Applied Fixes

  • README.md: Added exec-context-pr.js to the docs/ado-script.md description in the Compiler internals documentation section

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
  • 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 27155357980 -n agent -D /tmp/agent-27155357980

# Create a new branch
git checkout -b docs/fix-readme-ado-script-bundles-90982b08e67be2a5 main

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

# Push the branch and create the pull request
git push origin docs/fix-readme-ado-script-bundles-90982b08e67be2a5
gh pr create --title 'docs: fix documentation drift — add exec-context-pr.js to README ado-script bundle list' --base main --head docs/fix-readme-ado-script-bundles-90982b08e67be2a5 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 14.7M ·

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