Skip to content

docs: fix documentation drift — exec-context-pr-synth.js undocumented bundle #986

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree exec-context-pr-synth/ source directory missing from scripts/ado-script/src/ AGENTS.md
Technology Stack Description says "future bundles" but exec-context-pr-synth.js already ships in ado-script.zip AGENTS.md
docs index exec-context-pr-synth.js absent from docs/ado-script.md summary AGENTS.md
ado-script docs Says "three bundles" — should be four docs/ado-script.md
ado-script docs exec-context-pr-synth/ missing from workspace layout tree; exec-context-pr-synth.js missing from bundle-output list docs/ado-script.md
ado-script docs Release-workflow zip command and import.js paragraph omit exec-context-pr-synth.js docs/ado-script.md
ado-script docs "What gets emitted" table has no rows for the synth-PR path docs/ado-script.md
ado-script docs No "What exec-context-pr-synth.js does" section docs/ado-script.md
README ado-script.md reference lists only gate.js, import.js, missing exec-context-pr.js and exec-context-pr-synth.js README.md

Details

scripts/ado-script/src/exec-context-pr-synth/ is a fully operational fourth bundle. It runs in the Setup job before any gate step and normalises PR identifier variables into the stable AW_PR_* namespace consumed by the gate and Agent job — for both real PR builds and CI builds that are synth-promoted to PR semantics. It is compiled, bundled, and shipped in ado-script.zip alongside the other three bundles (gate.js, import.js, exec-context-pr.js). The release workflow at .github/workflows/release.yml already includes it in the zip command.

Despite this, every documentation file that describes the ado-script workspace omitted it entirely.

Applied Fixes

  • docs/ado-script.md: update intro from "three bundles" to "four bundles"; add exec-context-pr-synth.js bullet; add complete "What exec-context-pr-synth.js does" section (why it exists, variables emitted, runtime logic, env-var contract); update workspace layout tree to include exec-context-pr-synth/ source directory and exec-context-pr-synth.js bundle-output entry; update release-workflow description and import.js paragraph to include the fourth bundle; expand the "What gets emitted" table with synth-PR rows (synth-PR (no gate), gate (no synth-PR), synth-PR + gate) and clarify that the existing "no gate" rows assumed synth-PR not active
  • AGENTS.md: add exec-context-pr-synth/ to the architecture tree; update workspace description from "and future bundles" to the actual four-bundle list; update Technology Stack bullet
  • README.md: add exec-context-pr.js and exec-context-pr-synth.js to the ado-script.md reference entry

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

# Create a new branch
git checkout -b docs/fix-exec-context-pr-synth-bundle-23d2789cbedb007a main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27452480514/aw-docs-fix-exec-context-pr-synth-bundle.patch

# Push the branch and create the pull request
git push origin docs/fix-exec-context-pr-synth-bundle-23d2789cbedb007a
gh pr create --title 'docs: fix documentation drift — exec-context-pr-synth.js undocumented bundle' --base main --head docs/fix-exec-context-pr-synth-bundle-23d2789cbedb007a --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 14.4M ·

Metadata

Metadata

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