Generate readme for submodules

[goruha]

what

• Generate readme for submodules

why

• Allow all to keep the README updated

references

• https://linear.app/cloudposse/issue/DEV-3521/make-cicd-workflow-support-readmes-in-modules-subfolders

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Adds a commands section to atmos.yaml defining readme and test command groups with multiple sub-commands and steps. Updates modules/lambda@edge/README.md to reference Atmos commands instead of make-based workflow, with minor formatting adjustments.

Changes

Cohort / File(s)	Summary
Configuration atmos.yaml	Introduces top-level commands section with two command groups: readme (runs docs generation and README display for modules/lambda@edge) and test (defines init, run, clean sub-commands with multiple execution steps)
Documentation modules/lambda@edge/README.md	Updates workflow instructions from make/init/readme commands to Atmos equivalents; adds blank line after Usage header; adds minor formatting adjustments with extra closing details block markup

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Configuration additions are straightforward command definitions with no complex logic
• Documentation updates are mostly text replacements and minor formatting changes
• Changes follow established patterns with minimal risk of introducing issues

Possibly related PRs

• PR #342: Both PRs migrate from Makefile/workflow-based setup to Atmos-based commands by modifying atmos.yaml and updating README instructions
• PR #347: Both PRs update lambda@edge README and integrate Atmos-based README generation into the workflow

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Generate readme for submodules' directly relates to the main change: adding Atmos commands to generate README files for submodules (lambda@edge).
Description check	✅ Passed	The description clearly relates to the changeset, explaining the objective to generate readme for submodules and allow keeping READMEs updated.
Linked Issues check	✅ Passed	The PR implements Atmos-based commands (readme, test) in atmos.yaml and updates documentation to support README generation in module subfolders, aligning with DEV-3521's objective.
Out of Scope Changes check	✅ Passed	All changes are in-scope: atmos.yaml configuration for README and test commands, and lambda@edge README documentation updates directly support the PR's objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[goruha]

/terratest

[goruha]

/terratest