Skip to content

Fix typo in the remote_private_key error message - #27

Open
branchard wants to merge 1 commit into
kitconcept:mainfrom
branchard:fix-private-key-error-message
Open

Fix typo in the remote_private_key error message#27
branchard wants to merge 1 commit into
kitconcept:mainfrom
branchard:fix-private-key-error-message

Conversation

@branchard

Copy link
Copy Markdown

This PR fixes a small typo. The error message shown when remote_private_key is missing referenced private_key instead of the actual input name, which was confusing when troubleshooting a missing input.

fi
if [[ -z "${REMOTE_PRIVATE_KEY}" ]]; then
echo "Input private_key is required!"
echo "Input remote_private_key is required!"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
echo "Input remote_private_key is required!"
echo "Input REMOTE_PRIVATE_KEY is required!"

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

All other input names are lowercase in error messages, like Input stack_file is required! or Input remote_host is required!.

Comment thread tests/entrypoint.bats
run_entrypoint REMOTE_HOST=swarm.example.com REMOTE_USER=deploy
[ "$status" -eq 1 ]
[[ "$output" == *"Input private_key is required!"* ]]
[[ "$output" == *"Input remote_private_key is required!"* ]]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
[[ "$output" == *"Input remote_private_key is required!"* ]]
[[ "$output" == *"Input REMOTE_PRIVATE_KEY is required!"* ]]

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