Skip to content

[gh-aw update scan] gh-aw docs 331bd89 book update candidates #12

Description

@github-actions

Book framework baseline: content/FRAMEWORK_VERSION = v0.88.7
Prose edition: content/VERSION = 1.2

Scan date (UTC): 2026-09-20

Upstream inspected:

  • Latest stable release: v0.88.7 (published 2026-09-08) — unchanged; no newer non-prerelease exists yet.
  • Latest release overall (prerelease, watchlist only): v0.89.17
  • Documentation HEAD commit inspected: 331bd89db81226debd2831bcbb8d2e5bfedf21a5 ("docs: document edit/format commands, audit-diff tool, and fix chat-ops example (#61683)", 2026-09-18)
  • Baseline tag commit: bde367913adeb3132f0a171594c88a17f4b7d08c (2026-09-08T14:37:11Z)

Official sources checked

What changed

All 30+ releases newer than v0.88.7 (v0.88.8 through v0.89.17) are marked prerelease; v0.88.7 remains the latest stable tag, so no framework baseline bump is proposed. However, docs/main and the prerelease changelog show several capability changes worth reviewing for the next update cycle:

  1. New global/per-handler footer controlfooters.md reference page and a footer: false option at the safe-outputs: top level and per-handler (issues, PRs, discussions, releases) to suppress AI-generated attribution footers. Not present in the reviewed baseline docs.
  2. aw.yml package wildcard mapping to destination folders and shared JavaScript module installation — packages can now map workflow sources with more flexible destination wildcards and install shared .js modules alongside markdown (PR #59317, #60536).
  3. add-labels target restrictions enforcement — stricter enforcement of label allowlists/targets (PR #60362), relevant to the book's safe-outputs label-allowlist guidance.
  4. Agent-incomplete-work fail-fast — workflows now fail (rather than silently succeed) when an agent reports incomplete work (PR #59316), relevant to reliability/observability framing.
  5. Multiple "docs: unbloat ___ reference" rewritestools.md, network.md, frontmatter reference, imports.md, and workflow-structure.md were all substantially trimmed/restructured on docs/main after the baseline tag. Book excerpts anchored to specific baseline-tag doc wording/structure (not just tagged source URLs, which remain stable) should be spot-checked against the live restructured pages for drift in emphasis, even though the underlying schema likely didn't change.
  6. Logs/observability changes (JSONL enrichment, oldest-run pruning, cache diagnostics) — multiple PRs (#59453, #59454, #59338, #59336, #60058, #59988) affect CLI log tooling described in the observability chapter.

Book impact

Candidate Reason Priority Confidence
content/chapters/safe-outputs.html No mention of the new footer: false global/per-handler control or footers.md reference; safe-outputs chapter currently silent on footer customization Medium 7/10
content/chapters/fleets-and-adoption.html Wildcard package mapping is documented, but shared JS module installation (PR #60536) is not mentioned; package composition section may need a note Low–Medium 5/10
content/chapters/safe-outputs.html (add-labels section) Stricter add-labels target enforcement (#60362) may affect the label-allowlist guarantee described around line 41 Low 4/10
content/chapters/observability-and-debugging.html Logs CLI behavior (pruning modes, cache diagnostics, JSONL enrichment) changed materially across several PRs; verify described gh aw logs behavior still matches Low 4/10
content/research/ch08-features.md (safe-outputs) Underlying feature notes predate the footer-control addition; needs a fresh evidence pass if the framework baseline advances Medium 6/10
content/chapters/tools-and-mcp.html, content/chapters/triggers.html Corresponding docs pages (tools.md, network.md, triggers.md, imports.md) were reworded/"unbloated" on docs/main; schema likely unchanged but prose emphasis may have shifted — spot-check only Low 3/10

None of these are confirmed as compile-breaking or schema-breaking from the evidence gathered; they are candidates for review, not confirmed defects.

Verification work needed before any edit

  • Wait for (or explicitly track) the next stable, non-prerelease gh-aw release before advancing content/FRAMEWORK_VERSION; v0.88.7 is still the correct baseline today.
  • If/when a new stable tag lands, install it via scripts/install-gh-aw.ps1 (or gh extension install github/gh-aw --pin <tag>), diff the tagged docs/src/content/docs/reference/safe-outputs.md, footers.md, tools.md, network.md, imports.md, workflow-structure.md, and the aw_manifest_schema.json against the versions cited in the affected chapters above.
  • Re-run strict compilation of every example workflow touched by any resulting edit, and the full example corpus before changing content/FRAMEWORK_VERSION.
  • Confirm the footer: false option and footers.md page exist and behave as described against the actual next stable tag (not just docs/main) before citing them in prose.
  • Confirm the add-labels enforcement change (#60362) against the tagged schema/behavior, not just the PR title.

Uncertainties / access notes

  • All "what changed" items above were derived from GitHub release-note prose and docs commit messages/diffs, which are official but were not independently re-verified against a stable tagged checkout (no new stable tag exists yet). Treat items 1–6 as leads for the next maintenance cycle, not confirmed capability changes to act on immediately.
  • Full content of docs/src/content/docs/reference/safe-outputs.md at HEAD was fetched and spot-checked for footer terminology; the other listed reference pages were checked by directory listing and commit-message titles only, not full diffs, due to scan scope.

This workflow made no book-content or example changes. It is an advisory scan only.

Generated by gh-aw book update scout · copilot · auto · 96.3 AIC · ⌖ 4.89 AIC · ⊞ 7.1K ·

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions