-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Reformat plugin's vendor position and add version on --help #1675
Reformat plugin's vendor position and add version on --help #1675
Conversation
c095b8e
to
193896a
Compare
Codecov Report
@@ Coverage Diff @@
## master #1675 +/- ##
==========================================
+ Coverage 56.05% 56.13% +0.07%
==========================================
Files 306 306
Lines 20981 20970 -11
==========================================
+ Hits 11761 11771 +10
+ Misses 8371 8346 -25
- Partials 849 853 +4 |
Giving this a quick spin; DOCKER_HIDE_LEGACY_COMMANDS=1 docker --config=.docker-plugin-test --help
Usage: docker [OPTIONS] COMMAND
A self-sufficient runtime for containers
Options:
--config string Location of client config files (default "/root/.docker")
-c, --context string Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with "docker context use")
-D, --debug Enable debug mode
-H, --host list Daemon socket(s) to connect to
-l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info")
--tls Use TLS; implied by --tlsverify
--tlscacert string Trust certs signed only by this CA (default "/root/.docker/ca.pem")
--tlscert string Path to TLS certificate file (default "/root/.docker/cert.pem")
--tlskey string Path to TLS key file (default "/root/.docker/key.pem")
--tlsverify Use TLS and verify the remote
-v, --version Print version information and quit
Management Commands:
builder Manage builds
checkpoint Manage checkpoints
config Manage Docker configs
container Manage containers
context Manage contexts
engine Manage the docker engine
image Manage images
network Manage networks
node Manage Swarm nodes
plugin Manage plugins
secret Manage Docker secrets
service Manage services
stack Manage Docker stacks
swarm Manage Swarm
system Manage Docker
trust Manage trust on Docker images
volume Manage volumes
Commands:
build Build an image from a Dockerfile
helloworld* A basic Hello World plugin for tests (Docker Inc., testing)
login Log in to a Docker registry
logout Log out from a Docker registry
run Run a command in a new container
search Search the Docker Hub for images
version Show the Docker version information
Run 'docker COMMAND --help' for more information on a command. The new presentation of the plugin looks good to me 🤗 |
I just realise that I may not have mentioned that on the other PR (and probably something to address separately); Plugins (most likely) will have subcommands; if so, we should show plugins under |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had one small question, but overall looks good, thanks for picking this up!
Ack, I think that's separate from this change though, #1661 has a separate entry for it:
|
Ah, yes. I started looking why it wouldn't see |
@ulyssessouza I think a Unit terst for |
d6a05e5
to
a6b7d5f
Compare
1d7e053
to
35c7809
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
left one nit
- The placement of the vendor is now in the end of the line. - A '*' is now added as suffix of plugins' top level commands. Signed-off-by: Ulysses Souza <ulysses.souza@docker.com>
35c7809
to
9201360
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Checks the fourth box on: #1661
- What I did
- How I did it
By changing the
usageTemplate
in cli/cobra.go to replace the information and decorating the command with a '*' when it's a plugin's first level command- How to verify it
docker help
and check that the plugins' first level commands have now a '*' and it's vendor as short description suffix- Description for the changelog
Reformated plugins' first level command description on
--help
by replacing and vendor and adding version- A picture of a cute animal (not mandatory but encouraged)