Skip to content

docs: fix documentation drift — add exec-context-pr-synth.js and update version example #964

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
ado-script bundles exec-context-pr-synth.js (4th bundle) not documented anywhere; docs said "three bundles" docs/ado-script.md, AGENTS.md, README.md
ado-script source tree exec-context-pr-synth/ directory missing from architecture tree AGENTS.md
ado_script.rs comment Extension comment omitted synthetic-PR precompute role AGENTS.md
engine.version example Example version "1.0.48" is stale (current default: "1.0.60") docs/engine.md

Details

exec-context-pr-synth.js — missing 4th bundle

The workspace at scripts/ado-script/src/exec-context-pr-synth/ produces exec-context-pr-synth.js, which runs in the Setup job on CI-triggered builds (Build.Reason = IndividualCI). It calls the ADO REST API to find the active PR for Build.SourceBranch, applies on.pr.branches/on.pr.paths filters, and emits AW_SYNTHETIC_PR* outputs so downstream gate + exec-context-pr steps treat the build as a PR build even without a server-side Build Validation policy.

The compiler references it in src/compile/extensions/ado_script.rs. However, none of docs/ado-script.md, AGENTS.md, or README.md mentioned this bundle — they only listed three bundles.

docs/engine.md version example

The version: field table row used "1.0.48" as an example, but the current pinned COPILOT_CLI_VERSION in src/engine.rs is "1.0.60".

Applied Fixes

  • docs/ado-script.md: updated "three bundles" → "four bundles"; added exec-context-pr-synth.js bullet with description
  • AGENTS.md: added exec-context-pr-synth/ to ado-script source tree; updated ado_script.rs comment to mention synthetic-PR precompute; added exec-context-pr-synth.js to docs index entry
  • README.md: added exec-context-pr.js and exec-context-pr-synth.js to the ado-script reference link
  • docs/engine.md: updated stale version example "1.0.48""1.0.60"

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

# Create a new branch
git checkout -b docs/fix-documentation-drift-85640a0ee319e997 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27317661622/aw-docs-fix-documentation-drift.patch

# Push the branch and create the pull request
git push origin docs/fix-documentation-drift-85640a0ee319e997
gh pr create --title 'docs: fix documentation drift — add exec-context-pr-synth.js and update version example' --base main --head docs/fix-documentation-drift-85640a0ee319e997 --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