Skip to content

docs: fix documentation drift — README missing exec-context-pr.js in ado-script section #898

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
ado-script docs index README listed only gate.js and import.js as bundled TypeScript runtime helpers; exec-context-pr.js (added in issue #860) was missing README.md

Details

README.md (Docs Index section, line 609) described the ado-script workspace as:

bundled TypeScript runtime helpers: gate.js, import.js

However, exec-context-pr.js has been a third bundled script since the PR-context precompute feature (issue #860). The source exists at scripts/ado-script/src/exec-context-pr/, and both AGENTS.md and docs/ado-script.md correctly document all three scripts. Only the README docs index was out of date.

Applied Fixes

  • Updated README.md docs index entry for docs/ado-script.md to include exec-context-pr.js in the list of bundled TypeScript runtime helpers

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

# Create a new branch
git checkout -b docs/freshness-audit-exec-context-pr-605bc59ce4e8de8c main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27130078342/aw-docs-freshness-audit-exec-context-pr.patch

# Push the branch and create the pull request
git push origin docs/freshness-audit-exec-context-pr-605bc59ce4e8de8c
gh pr create --title 'docs: fix documentation drift — README missing exec-context-pr.js in ado-script section' --base main --head docs/freshness-audit-exec-context-pr-605bc59ce4e8de8c --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 8.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