cli: Output message on success writing config entry #7806
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
lkysow
reviewed
May 7, 2020
There was a problem hiding this comment.
I went hunting through the cli to see if there was prior art here.
consul services register service.hcl
Registered service: service-name
consul intention create foo bar
Created: foo => bar (allow)
consul intention match -source foo
foo => bar (allow)
There's not much but it looks like we do have a couple patterns:
- We use
<action>: <resource identifier>, e.g.Config entry written: <identifier> - We don't use "successfully"
- We don't use quotes in our identifier, e.g.
<name>/<kind> - Our docs use
Configurationbut the cli help uses justconfigso I think we're okay using config.
So to follow that pattern I think something more like:
Config entry written: global (proxy-defaults)
Also, can we add output to the delete as well?
|
👍 Good call out, I will take some time and review the CLI output of all our commands to make sure we are consistent here. |
|
Maybe add backport 1.8.x label? |
This provides a user with a better experience, knowing that the command worked appropriately. The output of the write/delete CLI commands are not going to be used in a bash script, in fact previously a success provided no ouput, so we do not have to worry about spurious text being injected into bash pipelines.
crhino
force-pushed
the
cli/config-write-output
branch
from
330aa89
to
503519e
Compare
|
Finally made a few changes to the output based on previous comments, re-requesting review. |
|
🍒✅ Cherry pick of commit ea683eb onto |
hashicorp-ci
pushed a commit
that referenced
this pull request
Jun 29, 2020
This provides a user with a better experience, knowing that the command worked appropriately. The output of the write/delete CLI commands are not going to be used in a bash script, in fact previously a success provided no ouput, so we do not have to worry about spurious text being injected into bash pipelines.
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.
This helps users feel like an action occurred, rather than no output leading them to wonder if it worked or not.
This also converts the formatting output of config entries from
"proxy-defaults" / "global"toproxy-defaults/globalas a slightly more readable form.