(#137) Nicer response when binary doesn't exist #149
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As reported in puppetlabs#137, when a user installs the PDK gem on a fresh machine that does not have git installed, they get an unhelpful message about git failing with a misleading reference to files inside the PDK. With this change, we instead check that the binary being called exists before attempting to execute it and raise an error suggesting that the user needs to install the appropriate package before trying again. This won't be a big issue once we have system packages going out, but it provides a nicer initial experience for users installing the gem. ``` root@stretch:~# pdk new module foo --skip-interview pdk (INFO): Creating new module: foo pdk (FATAL): Unable to find `git`. Check that it is installed and try again. root@stretch:~# apt-get install -y git [output trimmed] root@stretch:~# pdk new module foo --skip-interview pdk (INFO): Creating new module: foo root@stretch:~# ``` Fixes puppetlabs#137
bmjen
previously requested changes
Jul 13, 2017
| @@ -26,6 +26,7 @@ Gem::Specification.new do |spec| | |||
| spec.add_runtime_dependency 'tty-spinner', '~> 0.4' | |||
| spec.add_runtime_dependency 'tty-prompt', '~> 0.12' | |||
| spec.add_runtime_dependency 'json_pure', '~> 2.1.0' | |||
| spec.add_runtime_dependency 'tty-which', '~> 0.3.0' | |||
There was a problem hiding this comment.
Addition of this dependency will require some work on the packaging side. Going to hold this for 0.5.0 so we can have time for packaging work.
There was a problem hiding this comment.
Fair enough :) I've opened a PR on the packaging repo to add this component for 0.5.0
|
tty-which is now in the packaging. Can we get this moving again? @puppetlabs/pdk |
scotje
approved these changes
Jul 24, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As reported in #137, when a user installs the PDK gem on a fresh machine that
does not have git installed, they get an unhelpful message about git failing
with a misleading reference to files inside the PDK.
With this change, we instead check that the binary being called exists before
attempting to execute it and raise an error suggesting that the user needs to
install the appropriate package before trying again.
This won't be a big issue once we have system packages going out, but it
provides a nicer initial experience for users installing the gem.
Fixes #137