You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This audit found the following inconsistencies between code and documentation:
Findings
Area
Issue
File(s)
ado-script bundles
exec-context-pr-synth.js is a fourth bundle built, shipped in ado-script.zip, and referenced throughout the Rust compiler — but was never documented
docs/ado-script.md, AGENTS.md, README.md
Details
exec-context-pr-synth.js is a Setup-job Node script that normalises PR identifier variables (AW_PR_*) for downstream consumers. It runs on every PR build (real and synthetic) so that all downstream steps can read a single $(AW_PR_*) variable regardless of whether the build arrived as a native PullRequest build reason or a CI build promoted to PR semantics (the "synthetic PR" path).
The bundle is:
Built by npm run build:exec-context-pr-synth in scripts/ado-script/package.json
Zipped into ado-script.zip in .github/workflows/release.yml alongside the three previously-documented bundles
Injected into compiled pipelines by src/compile/extensions/ado_script.rs
Has its own source directory scripts/ado-script/src/exec-context-pr-synth/ with tests
Despite all of the above, it was entirely absent from:
docs/ado-script.md — intro claimed "three bundles", workspace layout tree and release description only named three files
AGENTS.md — architecture tree for scripts/ado-script/src/ omitted the directory; index entry listed only three bundles
README.md — documentation index entry listed only gate.js and import.js
Applied Fixes
docs/ado-script.md: updated bundle count to four, added exec-context-pr-synth.js bullet to the intro list, added exec-context-pr-synth/ directory + exec-context-pr-synth.js to the workspace layout tree, updated the release description to name all four zipped files
AGENTS.md: added exec-context-pr-synth/ to the scripts/ado-script/src/ directory tree; updated the docs/ado-script.md index entry to list all four bundles
README.md: updated the docs/ado-script.md reference line to list all four bundles
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 27408098281 -n agent -D /tmp/agent-27408098281
# Create a new branch
git checkout -b docs/fix-exec-context-pr-synth-bundle-4e3c6c9bf0cb7a08 main
# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27408098281/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-4e3c6c9bf0cb7a08
gh pr create --title 'docs: fix documentation drift — undocumented exec-context-pr-synth.js bundle' --base main --head docs/fix-exec-context-pr-synth-bundle-4e3c6c9bf0cb7a08 --repo githubnext/ado-aw
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
ado-scriptbundlesexec-context-pr-synth.jsis a fourth bundle built, shipped inado-script.zip, and referenced throughout the Rust compiler — but was never documenteddocs/ado-script.md,AGENTS.md,README.mdDetails
exec-context-pr-synth.jsis a Setup-job Node script that normalises PR identifier variables (AW_PR_*) for downstream consumers. It runs on every PR build (real and synthetic) so that all downstream steps can read a single$(AW_PR_*)variable regardless of whether the build arrived as a nativePullRequestbuild reason or a CI build promoted to PR semantics (the "synthetic PR" path).The bundle is:
npm run build:exec-context-pr-synthinscripts/ado-script/package.jsonado-script.zipin.github/workflows/release.ymlalongside the three previously-documented bundlessrc/compile/extensions/ado_script.rsscripts/ado-script/src/exec-context-pr-synth/with testsDespite all of the above, it was entirely absent from:
docs/ado-script.md— intro claimed "three bundles", workspace layout tree and release description only named three filesAGENTS.md— architecture tree forscripts/ado-script/src/omitted the directory; index entry listed only three bundlesREADME.md— documentation index entry listed onlygate.jsandimport.jsApplied Fixes
docs/ado-script.md: updated bundle count to four, addedexec-context-pr-synth.jsbullet to the intro list, addedexec-context-pr-synth/directory +exec-context-pr-synth.jsto the workspace layout tree, updated the release description to name all four zipped filesAGENTS.md: addedexec-context-pr-synth/to thescripts/ado-script/src/directory tree; updated thedocs/ado-script.mdindex entry to list all four bundlesREADME.md: updated thedocs/ado-script.mdreference line to list all four bundlesThis 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.mdREADME.mdCreate the pull request manually