Enable make readme target to use atmos docs generate#1988
Conversation
Switch from disabled stub to using the `atmos docs generate readme` command to regenerate README.md from README.yaml and remote template. This aligns with the implemented docs generate functionality and allows readme generation to work with `make readme`. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
|
Important Cloud Posse Engineering Team Review RequiredThis pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes. To expedite this process, reach out to us on Slack in the |
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
osterman
added
the
no-release
Move the Developer Tools section (testing Atmos in Geodesic) from README.md to docs/development.md where it belongs with other developer documentation. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughMakefile's Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1988 +/- ##
==========================================
+ Coverage 74.90% 74.91% +0.01%
==========================================
Files 777 777
Lines 71302 71302
==========================================
+ Hits 53409 53417 +8
+ Misses 14413 14406 -7
+ Partials 3480 3479 -1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
💥 This pull request now has conflicts. Could you fix it @osterman? 🙏 |
Resolved Makefile conflict by keeping: - Worktree detection logic from main (for development environments) - Working readme target from feature branch (uses atmos docs generate readme) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
34-36: Tighten grammar in the intro paragraph.Line 35 reads a bit ungrammatically (“Its strength in managing … and is supported …”). Consider a small edit for flow.
✏️ Suggested edit
-Its strength in managing DRY configurations at scale for Terraform and is supported by robust design patterns, comprehensive documentation, and a passionate community, making it a versatile tool for both startups and enterprises. +Its strength in managing DRY configurations at scale for Terraform is supported by robust design patterns, comprehensive documentation, and a passionate community, making it a versatile tool for both startups and enterprises.
🤖 Fix all issues with AI agents
In `@docs/development.md`:
- Around line 144-168: Update the wording in docs/development.md (section
"Testing Atmos in Geodesic") to clarify that the Atmos-managed credentials path
`~/.config/atmos/` follows XDG conventions and can be overridden by the
XDG_CONFIG_HOME environment variable; specifically, change the sentence that
currently states "Atmos-managed AWS credentials from `~/.config/atmos/`
(following XDG conventions)" to indicate that the default is `~/.config/atmos/`
but the actual location is determined by XDG_CONFIG_HOME if set (e.g.,
"$XDG_CONFIG_HOME/atmos or fallback to ~/.config/atmos"), and mention that the
scripts/test-geodesic-prebuilt.sh behavior will respect that lookup.
🧹 Nitpick comments (1)
Makefile (1)
20-21: Looks good — consider markingreadmeas phony.Nice to see the target wired to
./build/atmos docs generate readme. As a small hardening step, consider addingreadmeto the.PHONYlist to avoid any collision if a file namedreadmeappears.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@Makefile`:
- Around line 20-21: The readme target runs ./build/atmos which can be
non-executable if GOOS/GOARCH were set for cross-compiles; update the readme
recipe (target name: readme) to clear or override GOOS/GOARCH for just that
invocation (for example invoke the binary with GOOS= GOARCH= or use env -u GOOS
-u GOARCH ./build/atmos) so the host-built ./build/atmos is executed regardless
of the developer's cross-compile environment.
|
These changes were released in v1.204.1-rc.2. |
2 participants
what
make readmefrom a disabled stub to using theatmos docs generate readmecommandmake readmewhy
The
atmos docs generate readmecommand is fully implemented and working. Enabling the makefile target allows developers to regenerate the README.md following the documented workflow (edit README.yaml → runmake readme).references
Implements the intended workflow where
make readmegenerates README.md from data sources and templates, consistent with the modern docs generation infrastructure in Atmos.Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.