Skip to content

docs: fix documentation drift — add exec-context-pr-synth bundle to docs #978

@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 bundles exec-context-pr-synth.js is a real, shipped bundle but docs describe only three bundles docs/ado-script.md, AGENTS.md, README.md

Details

exec-context-pr-synth.js was added to solve a concrete ADO limitation (build #612528): $[ ... ] runtime expressions are not evaluated inside step env: values, only inside variables: blocks and condition: fields. The fix moved the real-vs-synthetic PR merge into a TypeScript Setup-job step that emits unified AW_PR_* variables, eliminating per-step coalesce expressions.

Despite being a real compiled+shipped bundle (listed explicitly in package.json's build, clean, and individual build:exec-context-pr-synth scripts), it was missing from:

  • docs/ado-script.md — still said "Today it produces three bundles" and had no ## What exec-context-pr-synth.js does section.
  • AGENTS.md — architecture tree was missing the exec-context-pr-synth/ source directory; the ado-script line described it as having "future bundles"; the docs index and Technology Stack entries listed only three bundles.
  • README.md — the docs/ado-script.md blurb listed only gate.js and import.js.

Applied Fixes

  • docs/ado-script.md: "three bundles" → "four bundles"; exec-context-pr-synth.js added to the opening list; new ## What exec-context-pr-synth.js does section with runtime steps, env-var contract (inputs and outputs), and the ADO limitation rationale; workspace layout tree updated; release packaging description updated.
  • AGENTS.md: exec-context-pr-synth/ added to the architecture tree; ado-script line comment, Technology Stack entry, and docs index entry all updated to list all four bundles.
  • README.md: docs/ado-script.md blurb updated to list exec-context-pr.js and exec-context-pr-synth.js.

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

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

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

# Push the branch and create the pull request
git push origin docs/fix-exec-context-pr-synth-bundle-docs-ddf0de593391589e
gh pr create --title 'docs: fix documentation drift — add exec-context-pr-synth bundle to docs' --base main --head docs/fix-exec-context-pr-synth-bundle-docs-ddf0de593391589e --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