Skip to content

Comments

fix: correct path references and env var names in agent README templates#364

Merged
notgitika merged 2 commits intomainfrom
fix/readme-path-and-envvar-references
Feb 20, 2026
Merged

fix: correct path references and env var names in agent README templates#364
notgitika merged 2 commits intomainfrom
fix/readme-path-and-envvar-references

Conversation

@tejaskash
Copy link
Contributor

Summary

  • Fixed all 6 agent framework README templates (strands, crewai, autogen, langchain_langgraph, googleadk, openaiagents) that referenced nonexistent paths from an older project layout (src/main.py, src/model/load.py, .agentcore) — updated to main.py, model/load.py, agentcore/
  • Replaced hardcoded env var names (AGENTCORE_IDENTITY_OPENAI, AGENTCORE_IDENTITY_ANTHROPIC, AGENTCORE_IDENTITY_GEMINI) with dynamic Handlebars template using {{identityProviders.[0].envVarName}}, gated by {{#if hasIdentity}} so Bedrock projects (IAM auth) correctly omit the API key row
  • Added src/assets/**/*.md to .prettierignore since asset markdown files contain Handlebars template syntax that prettier cannot parse correctly

Test plan

  • npm run test:update-snapshots — 6 snapshots updated
  • Asset snapshot tests all pass
  • Verify rendered README for a non-Bedrock project includes the dynamic env var row
  • Verify rendered README for a Bedrock project omits the API key row and only shows LOCAL_DEV

All 6 agent framework README templates referenced nonexistent paths
(src/main.py, src/model/load.py, .agentcore) from an older layout.
Updated to match the actual generated project structure (main.py,
model/load.py, agentcore/). Also replaced hardcoded env var names
(AGENTCORE_IDENTITY_OPENAI etc.) with dynamic Handlebars template
using identityProviders.[0].envVarName, gated by hasIdentity so
Bedrock projects omit the API key row.

Added src/assets/**/*.md to .prettierignore since asset markdown
files are Handlebars templates that prettier cannot parse correctly.
@tejaskash tejaskash requested a review from a team February 20, 2026 16:10
@github-actions github-actions bot added the size/m PR size: M label Feb 20, 2026
The actual env file used is agentcore/.env.local (constant ENV_FILE
in src/lib/constants.ts), not agentcore/.env.
@github-actions
Copy link
Contributor

github-actions bot commented Feb 20, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 43.54% 2884 / 6623
🔵 Statements 43.15% 3040 / 7045
🔵 Functions 45.68% 609 / 1333
🔵 Branches 48.48% 1893 / 3904
Generated in workflow #472 for commit 443b2d8 by the Vitest Coverage Report Action

@github-actions github-actions bot added size/m PR size: M and removed size/m PR size: M labels Feb 20, 2026
Copy link
Contributor

@notgitika notgitika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@notgitika notgitika merged commit 592af45 into main Feb 20, 2026
17 of 18 checks passed
@notgitika notgitika deleted the fix/readme-path-and-envvar-references branch February 20, 2026 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants