Skip to content

docs: fix documentation drift — exec-context-pr-synth.js fourth ado-script bundle undocumented #985

@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 Says "three bundles" — there are actually four docs/ado-script.md
ado-script bundles exec-context-pr-synth.js missing from bundle list docs/ado-script.md
ado-script workspace layout exec-context-pr-synth/ source dir absent from tree docs/ado-script.md
ado-script workspace layout exec-context-pr-synth.js absent from bundle output list docs/ado-script.md
ado-script release zip Zip contents description missing exec-context-pr-synth.js docs/ado-script.md
Architecture tree scripts/ado-script/src/exec-context-pr-synth/ missing AGENTS.md
Architecture tree ado_script.rs description omits synth normalizer AGENTS.md
Docs index ado-script.md entry only lists three bundles AGENTS.md
README docs index ado-script reference lists only gate.js + import.js README.md

Details

exec-context-pr-synth.js is the fourth bundle in the ado-script.zip release asset (confirmed in .github/workflows/release.yml line 80 and src/compile/extensions/ado_script.rs EXEC_CONTEXT_PR_SYNTH_PATH constant). It runs in the Setup job before prGate and normalizes PR-identifier variables (AW_PR_ID, AW_PR_TARGETBRANCH, AW_PR_SOURCEBRANCH, AW_SYNTHETIC_PR, AW_SYNTHETIC_PR_SKIP) for both real PR builds and CI builds synthetically promoted to PR semantics. Its source lives in scripts/ado-script/src/exec-context-pr-synth/ (index.ts, match.ts, spec.ts, __tests__/).

No issues were found in docs/cli.md, docs/front-matter.md, docs/template-markers.md, src/compile/types.rs field coverage, or prompts/create-ado-agentic-workflow.md.

Applied Fixes

  • docs/ado-script.md: "three bundles" → "four bundles"
  • docs/ado-script.md: Added exec-context-pr-synth.js to intro bundle list with description
  • docs/ado-script.md: Added exec-context-pr-synth/ (index.ts, match.ts, spec.ts, __tests__/) to workspace layout tree
  • docs/ado-script.md: Added exec-context-pr-synth.js to bundle output list
  • docs/ado-script.md: Updated release zip contents description to include all four bundles
  • AGENTS.md: Added exec-context-pr-synth/ to architecture tree
  • AGENTS.md: Updated ado_script.rs description to include synth normalizer
  • AGENTS.md: Updated docs index entry to list all four bundles
  • README.md: Updated ado-script.md reference 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 27431746162 -n agent -D /tmp/agent-27431746162

# Create a new branch
git checkout -b docs/fix-exec-context-pr-synth-documentation-061791189413caa9 main

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

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

Generated by Documentation Freshness Check · sonnet46 8.6M ·

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