Skip to content
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.

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

Inconsistency in README for version pinning #95

Open
rwohleb opened this issue Aug 1, 2024 · 0 comments
Open

Inconsistency in README for version pinning #95

rwohleb opened this issue Aug 1, 2024 · 0 comments
Labels
bug 🐛 An issue with the system

Comments

@rwohleb
Copy link

rwohleb commented Aug 1, 2024

Found a bug? Maybe our Slack Community can help.

Slack Community

Describe the Bug

The README usage section says to use version to pin the atmos version, but the input section then gives atmos-version (which matches with action.yml). To make things more confusing, the docs on the website say to use atmos_version (underscore instead of dash).

Expected Behavior

Consistency in the documentation for input variables.

Steps to Reproduce

Steps to reproduce the behavior:

  1. Go to '...'
  2. Run '....'
  3. Enter '....'
  4. See error

Screenshots

If applicable, add screenshots or logs to help explain your problem.

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

  • OS: [e.g. Linux, OSX, WSL, etc]
  • Version [e.g. 10.15]

Additional Context

Add any other context about the problem here.

@rwohleb rwohleb added the bug 🐛 An issue with the system label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 An issue with the system
Projects
None yet
Development

No branches or pull requests

1 participant