Skip to content

[AAASM-4703] 🐛 (examples): Generator-own the README prerequisites SDK version#309

Merged
Chisanan232 merged 2 commits into
masterfrom
v0.0.1/AAASM-4703/readme_prereq_row
Jul 16, 2026
Merged

[AAASM-4703] 🐛 (examples): Generator-own the README prerequisites SDK version#309
Chisanan232 merged 2 commits into
masterfrom
v0.0.1/AAASM-4703/readme_prereq_row

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

What changed

Every example README carries a generated sdk-install block (rc.5) and a
hand-written ## Prerequisites table with an | Agent Assembly <Lang> SDK | <ver> |
row that lived outside the block. That prose row was hand-maintained and had
drifted: 4 Go READMEs still said v0.0.1-rc.3, 16 Python READMEs said >= 0.0.1rc3
(agno-tool-policy >= 0.0.1b4, langchain-research-agent >= 0.0.1b2), and the
scenarios/policy-enforcement README said >= 0.0.1rc3 — all contradicting the
generated rc.5 in the same file.

This PR makes the generator own that version value so the two can never
disagree again:

  • Adds a label-driven prereq-row pass to scripts/generate_example_metadata.py.
    For each README it rewrites only the version token in the
    | Agent Assembly <Lang> SDK | ... | row for whichever language label the row
    carries, using metadata/sdk-versions.yaml as the source of truth.
  • The >= operator and any trailing note (e.g. llamaindex's
    (with the LlamaIndex adapter)) are preserved verbatim — only the version
    literal changes.
  • The label cell is matched exactly (Agent Assembly <Lang> SDK, no
    parenthetical), which is precisely what distinguishes the prose row from the
    generated block's own row, so the generated block is never touched.
  • Regenerates all 21 affected READMEs to a single rc.5 prerequisite.

The generator remains idempotent (CI drift check).

Related ticket

Closes AAASM-4703

Jira: https://lightning-dust-mite.atlassian.net/browse/AAASM-4703

Stacked PR

This PR is stacked on #308 (AAASM-4702) and branches from
v0.0.1/AAASM-4702/scenario_pin_tooling. Its base is master per repo
convention; review/merge #308 first. The two-commit diff here is the only
delta over #308.

How to verify

python scripts/generate_example_metadata.py && git diff --exit-code   # idempotent
# no stale prereq version literal remains:
grep -rn "| Agent Assembly .*SDK | .*0.0.1\(rc3\|-rc.3\|b[0-9]\)" --include=README.md .

Checklist

  • PR title follows [AAASM-XXXX] <GitEmoji> (<scope>): <summary>
  • No secrets, API keys, or .env files committed
  • Example sub-projects include their own README.md with prerequisites and run instructions
  • SDK/runtime version dependencies are documented or pinned

@Chisanan232

Copy link
Copy Markdown
Contributor Author

Review (AAASM-4703) — READY (stacked on #308; merge after it).

  • Scope: the metadata generator now owns the hand-written Prerequisites SDK-version row (label-matched so the generated sdk-install block is untouched); 21 READMEs regenerated to a single rc.5.
  • Side effects: generator idempotent; operator (>=) and trailing adapter notes preserved; no stale rc3/b# prereq literal remains. Depends on [AAASM-4702] 🐛 (examples): Cover scenario agents in bump tooling + dependabot #308 being merged first.

CI: all required checks green. Front-end: no FE/dashboard code touched — Playwright validation N/A. Merge state: BLOCKED only on the required ≥1 Pioneer approval (branch protection), not on any failure.

— Reviewed by Claude Code

Each README's prose "## Prerequisites" table carried a hand-written
`| Agent Assembly <Lang> SDK | <version> |` row that lived outside the
generated sdk-install block and drifted from the source of truth (rc.3 / an
old beta vs. the block's rc.5) — AAASM-4703.

Add a label-driven pass that rewrites only the version token in that row for
whichever language label it carries, preserving the `>=` operator and any
trailing note (e.g. the LlamaIndex adapter caveat). The label cell is matched
exactly, so the generated block's own row is never touched. Idempotent.
Run the generator so all 21 hand-written prerequisites SDK-version rows
(16 python, 4 go, 1 scenario) advertise the single source-of-truth rc.5,
matching each README's generated sdk-install block.
@Chisanan232
Chisanan232 force-pushed the v0.0.1/AAASM-4703/readme_prereq_row branch from 45f6439 to 1b75878 Compare July 16, 2026 02:28
@sonarqubecloud

Copy link
Copy Markdown

@Chisanan232

Copy link
Copy Markdown
Contributor Author

Rebased onto latest master. #308 (its stack parent) merged as b588249, so this branch was rebased onto current master — its 2 own commits replay cleanly on top of the merged parent work (no conflicts). Generator re-verified idempotent (generate_example_metadata.pygit diff --exit-code clean). Base stays master; now a standalone PR.

⚠️ Pre-existing gap noted (not caused by the rebase): go/README.md:33 still reads - Agent Assembly Go SDK v0.0.1-rc.3. It's a bullet-list prereq, whereas this PR's generator only owns table-row prereqs (| Agent Assembly <Lang> SDK | … |), so the top-level go README bullet was missed. Named in AAASM-4703's scope — worth a follow-up (extend the generator to also own the bullet form so it can't drift again).

— Reviewed by Claude Code

@Chisanan232
Chisanan232 merged commit d82190c into master Jul 16, 2026
44 checks passed
@Chisanan232
Chisanan232 deleted the v0.0.1/AAASM-4703/readme_prereq_row branch July 16, 2026 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant