[AAASM-4743] 📝 (examples): Fix stale docs (workflows table, rename links, version comment, gateway-image status)#320
Merged
Conversation
All four verify-*.yml workflows already exist and run, plus six more (verify-all-samples, verify-live, example-metadata-check, codeql, proof-html, auto-assign) that the README never documented.
agno/autogen/semantic-kernel/strands-agents-tool-policy READMEs still linked github.com/AI-agent-assembly/agent-assembly-examples (dropped in the 2026-07-09 org repo rename, AAASM-4341). Point at github.com/ai-agent-assembly/examples, matching the sibling haystack-tool-policy / llamaindex-tool-policy READMEs.
The pin below the comment was already bumped to 0.0.1rc6 (the generator manages the version literal), but the rationale comment still claimed rc5 was the latest installable version. Follow openai-agents-sdk's pattern of citing AAASM-4441's exception notes instead of a hardcoded version so the comment can't go stale on the next SDK bump.
ghcr.io/ai-agent-assembly/aa-gateway is now published (confirmed tags
v0.0.1-rc.4/rc.5/rc.6/latest via the GHCR anonymous tags/list API) —
update the "Heads-up" callout, Prerequisites row, and Gateway image
dependency section that all asserted it was unpublished.
Not changed: verify-scenarios.yml still gates the real end-to-end
live-core-enforcement-live job behind workflow_dispatch only, per its
own comment ("Trigger it deliberately ... when a gateway image is
available"). That CI gate is now stale too, but reworking it is out of
scope here — noted in the PR description instead.
|
Contributor
Author
Claude Code — automated reviewCI: All green — full example + scenario matrix (all framework samples, metadata-drift, offline scenarios) pass. Scope vs AAASM-4743: Complete. Coming-soon workflow table replaced with the real set; 4 stale pre-rename repo links fixed; rc5 orphan comment re-pointed to the exception ticket; live-core-enforcement README corrected (gateway image IS published, verified via GHCR). Generator Side effects: None — documentation-only; a stale CI-trigger comment in verify-scenarios.yml was flagged for a separate follow-up, not changed here. Verdict: ✅ Ready for approval & merge. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



What changed
Four LOW-severity doc-drift items found against AAASM-4743, each an atomic commit:
.github/workflows/README.md— the "Planned workflows / coming soon" tablelisted only
verify-python.yml/verify-node.yml/verify-go.yml/verify-scenarios.ymlas unimplemented. All four already exist and run,plus six more (
verify-all-samples.yml,verify-live.yml,example-metadata-check.yml,codeql.yml,proof-html.yml,auto-assign.yml). Rewrote the table to list the full, actually-implementedworkflow set and dropped the "coming soon" framing.
python/{agno,autogen,semantic-kernel,strands-agents}-tool-policy/README.mdeach linked the pre-rename repo
github.com/AI-agent-assembly/agent-assembly-examples(dropped org-wide in the 2026-07-09 rename, AAASM-4341 — old URLs
301-redirect, but the doc text was stale). Repointed to
github.com/ai-agent-assembly/examples, matching the siblinghaystack-tool-policy/llamaindex-tool-policyREADMEs, which alreadyused the correct URL.
python/microsoft-agent-framework-tool-policy/pyproject.toml— therationale comment above the
agent-assemblypin said "0.0.1rc5 remains thelatest installable version," but the pin itself was already
==0.0.1rc6(the version literal is generator-owned and had been correctly bumped; only
the comment had gone stale). Rather than just re-hardcoding "rc6," followed
python/openai-agents-sdk/pyproject.toml's existing pattern of citing theAAASM-4441 exception notes instead of a specific version, so the comment
can't drift again on the next SDK bump.
scenarios/live-core-enforcement/README.md— the "Heads-up" callout, thePrerequisites row, and the "Gateway image dependency" section all asserted
ghcr.io/ai-agent-assembly/aa-gatewayis not published. It now is —confirmed live via the GHCR anonymous-token
tags/listAPI, which returnedv0.0.1-rc.4,v0.0.1-rc.5,v0.0.1-rc.6, andlatest. Updated all threespots to describe the gateway as a separate-but-published image rather than
an unpublished blocker.
Not changed, flagged for awareness:
verify-scenarios.yml'slive-core-enforcement-livejob is still gatedif: github.event_name == 'workflow_dispatch'with a comment saying to trigger it manually "when agateway image is available." That comment is now stale too (the image is
published), but reworking the CI trigger/gate is a behavior change outside
this ticket's doc-drift scope — flagging it here rather than changing CI
behavior unilaterally. A follow-up ticket could promote that job to run
automatically now that the image dependency is satisfied.
Related ticket
https://lightning-dust-mite.atlassian.net/browse/AAASM-4743
Fixes AAASM-4743
How to verify
.github/workflows/— diff the table inREADME.mdagainstls .github/workflows/*.yml; all ten files are now listed.grep -rn "AI-agent-assembly/agent-assembly-examples" python/now returns nothing; the four READMEs match the
github.com/ai-agent-assembly/examplesURL already used byhaystack-tool-policy/llamaindex-tool-policy.python scripts/generate_example_metadata.py --checkpasses with no drift(run after all four commits — the pyproject.toml comment change doesn't
touch the generator-owned version literal).
environment) — this PR only corrects the published/unpublished factual
claim in the docs, not the runtime behavior.
Checklist
[AAASM-XXXX] <GitEmoji> (<scope>): <summary>.envfiles committedREADME.mdwith prerequisites and run instructions