Skip to content

chore: update README.yaml to correct example usage of atmos-version - #104

Merged
Ben (Benbentwo) merged 2 commits into
cloudposse:mainfrom
jasonwashburn:chore/fix-version-var-ref-in-readme
Feb 23, 2026
Merged

Ben (Benbentwo) merged 2 commits into
cloudposse:mainfrom
jasonwashburn:chore/fix-version-var-ref-in-readme

Conversation

@jasonwashburn

Copy link
Copy Markdown
Contributor

what

README example of how to specify version of atmos to use, version vs atmos-version.

why

Documentation is incorrect.

references

Was previously "fixed" in another PR by manually editing README.md, however that fix seems to have been overwritten by an automation. The README mentions using a makefile task to generate the README, but that reference also appears to be outdated in favor or some upstream atmos tooling somewhere?

@jasonwashburn

Copy link
Copy Markdown
Contributor Author

🤔 I'm honestly not sure why the diff is showing so many changed lines...there doesn't seem to be any difference in whitespace chars that I can tell or formatting. My actual desired change is only to 2 lines that contain version -> atmos-version

@Benbentwo Ben (Benbentwo) left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Agreed, not sure why it's showing such a large diff.

Can you run atmos docs generate readme so the markdown gets updated as well.

Otherwise LGTM

@jasonwashburn
Jason Washburn (jasonwashburn) force-pushed the chore/fix-version-var-ref-in-readme branch from c99852b to f5cbca4 Compare February 18, 2026 16:47
@jasonwashburn

Copy link
Copy Markdown
Contributor Author

Can you run atmos docs generate readme so the markdown gets updated as well.

Yup, no problem, done!

@Benbentwo
Ben (Benbentwo) merged commit 822766b into cloudposse:main Feb 23, 2026
8 of 10 checks passed
@github-actions

Copy link
Copy Markdown

These changes were released in v2.1.0.

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.

2 participants