Skip to content

Use atmos for readme generation #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Igor Rodionov (goruha) merged 1 commit into from
Sep 16, 2025
Merged

Use atmos for readme generation #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ build-harness/
aws-assumed-role/
.idea/
*.iml
.atmos

# Compiled or generated files
# Compiled and auto-generated files
Expand Down
5 changes: 5 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,8 @@ bash/fmt/check:
shfmt -d $(PWD)/rootfs

.PHONY: all %.all build %.build install %.install run %.run run/new run/check

readme/build:
@atmos docs generate readme

readme: readme/build
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@

<!-- markdownlint-disable -->
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/geodesic/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
<p align="right">
<a href="https://github.com/cloudposse/geodesic/actions?query=workflow%3Adocker"><img src="https://github.com/cloudposse/geodesic/workflows/docker/badge.svg" alt="Build Status"/></a><a href="https://github.com/cloudposse/geodesic/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/geodesic.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a><a href="https://archive.sweetops.com/geodesic"><img src="https://img.shields.io/badge/slack-archive-blue.svg" alt="Slack Archive"/></a></p>


<p align="right"><a href="https://github.com/cloudposse/geodesic/actions?query=workflow%3Adocker"><img src="https://github.com/cloudposse/geodesic/workflows/docker/badge.svg" alt="Build Status"/></a><a href="https://github.com/cloudposse/geodesic/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/geodesic.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a><a href="https://archive.sweetops.com/geodesic"><img src="https://img.shields.io/badge/slack-archive-blue.svg" alt="Slack Archive"/></a><a href="https://cloudposse.com/support/"><img src="https://img.shields.io/badge/Get_Support-success.svg?style=for-the-badge" alt="Get Support"/></a>

</p>
<!-- markdownlint-restore -->

<!--
Expand Down Expand Up @@ -278,6 +281,10 @@ document, available from within the shell via `man customization`.







## Related Projects

Check out these related projects.
Expand Down
12 changes: 12 additions & 0 deletions atmos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Atmos Configuration — powered by https://atmos.tools
#
# This configuration enables centralized, DRY, and consistent project scaffolding using Atmos.
#
# Included features:
# - Organizational custom commands: https://atmos.tools/core-concepts/custom-commands
# - Automated README generation: https://atmos.tools/cli/commands/docs/generate
#

# Import shared configuration used by all modules
import:
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/default.yaml
Comment on lines +11 to +12
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Sep 9, 2025

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Pin remote import to a commit/tag for reproducibility

Using refs/heads/main is non-deterministic and a supply-chain risk. Pin to a commit SHA or a released tag.

 import:
-  - https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/default.yaml
+  - https://raw.githubusercontent.com/cloudposse/.github/<PINNED_COMMIT_SHA>/.github/atmos/default.yaml

Optionally document how to update the pin.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
import:
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/default.yaml
import:
- https://raw.githubusercontent.com/cloudposse/.github/<PINNED_COMMIT_SHA>/.github/atmos/default.yaml
🤖 Prompt for AI Agents 
In atmos.yaml around lines 11 to 12, the remote import currently references the
branch ref "refs/heads/main", which is non-deterministic; replace that URL with
one pinned to a specific commit SHA or a released tag (e.g.,
.../raw/<tag-or-sha>/.github/atmos/default.yaml) to ensure reproducible builds,
and optionally add a short comment above the import describing how to update the
pin (e.g., instructing to update to a new tag or SHA and run any verification).