cloudposse / cloudposse/github-action-setup-atmos

Inconsistency in README for version pinning

Open
#95 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
TypeScript
Stars
9
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Found a bug? Maybe our [Slack Community](https://slack.cloudposse.com) can help.

[![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)

## 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](https://atmos.tools/integrations/github-actions/setup-atmos) 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.